Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Innsynsformatet definerer og beskriver den informasjon som skal vises for innbygger når innbygger ber om innsyn i et register. I tillegg angir det hvordan informasjonen skal presenteres for bruker.

Ved å benytte et generelt, felles innsynsformat kan hver enkelt registereier ha kontroll over hvilke data som vises og grupperes sammen - og hvordan det skal se ut. Samtidig blir det presentert på en standardisert og gjenkjennbar måte for innbygger på tvers alle alle registre.

Dokumentasjon: FERDIG Løsningen: I DRIFT

Generelt

Hvordan fungerer det?

Helsenorge har definert et “generisk innsynformat”. Dette er et “meta-språk” som gjør det mulig å strukturere og delvis formatere responsen med opplysninger som kommer fra registrene. På Helsenorge vil responsen vises for innbygger og formateres tilpasset innbyggers enhet.

Formatet (hva som er mulig og hva som er lov) er definert av Helsenorge i to forskjellige XSDer:

  1. Et skjema (XSD) for representasjon av innhold, dvs. de opplysninger som er registrert om innbygger.

  2. Et annet skjema ( XSD) for tabularisk oversikt over logg over bruk, eller logg over utleveringer av innbyggers registrerte opplysninger.

Registeret bygger opp en XML-struktur med innholdet fra registeret som skal presenteres basert på riktig XSD avhengig av brukstilfelle over. På Helsenorge presenteres innholdet på en standardisert måte for innbygger som også er tilpasset den enhet innbygger benytter.

Når innbygger er på Helsenorge og ber om å få se innsynsrapport fra et register sender det aktuelle registeret en XML-fil som inneholder opplysninger for aktuell innbygger til Helsenorge.

Helsenorge tolker XML-filen og presenterer den til innbygger på definert måte.

Hva kan innsynsformatet brukes til?

  • Visning av registerinnhold på Helsenorge

  • Visning av logg over bruk av registeropplysninger på Helsenorge

  • Visning av logg over utleveringer av registeropplysninger på Helsenorge

Krav samt tips og råd til oppbygning og innhold

Hva

Krav

Tips og råd

Visning av registerinnhold

  • Det må komme tydelig frem om det som presenteres er et utdrag av informasjonen som finnes i registeret eller om det er et komplett innsyn

    • Hvis tjenesten gir innbygger innsyn i alle opplysninger som er registrert:
      Eks: "Her kan du se alle opplysninger som er registrert om deg i [navn på register]."

    • Hvis tjenesten dekker delvis innsynsrett for innbygger:
      Det må beskrives hvilke (typer/kategorier) opplysninger innbygger ikke får innsyn i, hvorfor man ikke får innsyn i disse opplysningene, og kontaktinformasjon for å be om fullt innsyn.

    • Eks: "[Navn på register] gir deg digitalt innsyn i de opplysningene som antas å være av betydning for deg. De opplysningene du ikke kan se her er [beskrive opplysningene, kategorier av opplysninger]. Grunnen til at dette ikke er med i det digitale innsynet er [årsaker]. Dersom du ønsker fullt innsyn i alle registrerte opplysninger må du ta kontakt med [navn på register], [kontaktinformasjon register]."

  • Lag en oversiktlig, ryddig og intuitiv struktur og oppbygning av innholdet

  • Gi støtteinformasjon og veiledning til innbygger slik at presentasjonen av registerinnholdet blir selvforklarende. Det finnes egne elementer for dette som tydelig skiller seg fra registerinnholdet slik at det blir enkelt for innbygger å se forskjell.

  • Presenter selve registerinnholdet gjennom bruk av de øvrige elementene som finnes tilgjengelig i formatet og er beregnet til å bruke på selve registerinnholdet

Visning av logg over bruk av registeropplysninger på Helsenorge

Tabell som viser Logg over bruk må inneholde følgende kolonner, i denne rekkefølgen:

  1. Når (må inneholde dato på følgende format: dd.mm.åååå)

  2. Hvem

  3. Virksomhet

  4. Bakgrunn

Ingen kolonner skal være tomme. Alle må inneholde opplysninger

  • Kolonne "Hvem" bør inneholde:

    • Navn på person som har gjort innsyn, eller ev. nr som skiller på saksbehandlere / de som har gjort innsyn

    • Navn på innbygger / den registrerte når denne selv har gjort innsyn (via Helsenorge)

    • Navn på innbygger som har gjort innsyn på vegne av den registrerte (via Helsenorge), inkl tekst som viser at innsynet er gjort via representasjon, for eksempel: "<Fornavn Etternavn> (innsyn ved foreldreansvar, fullmakt eller verge)".

  • Det er mulig å legge inn en liten ledetekst over logg-tabellen som beskriver hva loggen er og hvordan den fungerer.

  • Vi anbefaler ikke å bruke egen tittel i responsen siden dette allerede er innebygd og ivaretatt på Helsenorge på bakgrunn av hva slags respons som blir sendt.

Visning av logg over utleveringer av registeropplysninger på Helsenorge

Samme som over

Samme som over

Hvordan kan du formatere innholdet (visning av registerinnhold)?

Når du skal lage en presentasjon og visning av innholdet som kommer fra registeret kan du benytte følgende elementer til å formatere og angi hvordan det skal bli presentert for innbygger.

Det er mulig å lese og forstå alle muligheter og regler gjennom å se på XSDen, men presentasjonen under er en forenklet og mer leservennlig forklaring av de muligheter og alternativer som finnes. Her ser du også når og hva de ulike alternativene er egnet for samt eksempler.

 Hovedinndeling og struktur

Hovedinndeling og struktur

Elementtype

Til hva / når brukes dette

Nærmere beskrivelse

Regler

Alternativer og detaljer

Eksempel på bruk og utseende

Seksjoner med tittel 
<Section title="">

For å skape navigasjon og et hierarki som innholdet kan plasseres inn i.

Dette er hovedinndelingen og strukturen for innholdet som gjør det mulig for bruker å få oversikt og navigere i innholdet.

  • Lager en blokk som inneholder en titteltekst og som kan åpnes og lukkes.

  • Størrelsen på tittelen avhenger av hvor i hierarkiet seksjonen befinner seg.

  • Alle seksjoner kan åpnes og lukkes av bruker

  • Du kan angi om seksjonen skal være åpen eller lukket som default

  • Det kan være lurt å vurdere hvor viktig informasjonen er for innbyggeren, og hvor oversiktlig det evt. blir, før man bestemmer om en seksjon i utgangspunktet skal være åpen eller kollapset.

  • Du kan ha så mange seksjoner du ønsker på samme nivå

  • Du kan ha så mange nivåer du vil med seksjoner inni hverandre:

    • Hovedseksjon

      • Underseksjon

        • Under-underseksjon

I hver seksjon kan du benytte alternativene under for å presentere innholdet på ønsket måte. Du kan bruke så mange av variantene du ønsker og i den rekkefølgen du selv ønsker.

 Presentasjon av registerinnhold

Presentasjon av registerinnhold inne i en seksjon

For selve innholdet som ligger i registeret knyttet til hver enkelt innbygger finnes det flere alternativer. Du kan selv bygge opp innholdet med de av disse elementene som egner seg - og kombinere dem i den rekkefølgen du ønsker.

Noen elementer er det mulig å bruke inni hverandre, andre kan bare brukes over og under hverandre. Se XSDen for detaljer knyttet til dette.

Elementtype

Til hva / når brukes dette

Nærmere beskrivelse

Regler

Alternativer og detaljer

Eksempel på bruk og utseende

Avsnitt med formaterte tekstnivåer 
<FormattedText>

For å presentere registerinnhold fra registeret på en strukturert måte hvor det er naturlig å dele det inn i en tittel, sub-tittel og beskrivelse.

Brukes bare når det er mye innhold i en seksjon eller det av andre grunner er behov for å dele opp innholdet (som mellomtitler i en artikkel) uten at det skal vises i egne ekspanderbare seksjoner.


  • Kan brukes hvor som helst i strukturen (over og under andre elementer uavhengig av hvilket nivå i hierarkiet/seksjonene)

  • Tittelen er alltid ett nivå lavere i tittel-hierarkiet (h1-h6) enn tittelen som genereres for seksjonen tittelen vises i. Dersom seksjonen har tittel i <h2>, vil <Title> i denne seksjonen alltid være <h3>

  • Subtittelen er alltid to nivå lavere i tittel-hierarkiet (h1-h6) enn tittelen som genereres for seksjonen tittelen vises i. Dersom seksjonen har tittel i <h2>, vil <Subtitle> i denne seksjonen alltid være <h4>.

  • Tittel - <Title>

  • Sub-tittel - <Subtitle>

  • Beskrivelse - <Lead>

Bilde med beskrivelse 
<Image title="Bildetittel" >

For å presentere registerinnhold i form av bilder som er lagret om personen eller for å vise trender og utvikling over tid (som f.eks grafer og liknende)

  • Viser et bilde gjennom å presentere en binær representasjon som er inkludert i innsynsformatet



Lister
<OrderedList>
<UnorderedList>

For å presentere registerinnhold hvor det er naturlig å liste opp opplysninger i en samlet gruppe (nummerert eller unummerert)

  • Lager en punktliste eller en nummerert liste av elementer

  • Kan brukes hvor som helst i strukturen (over og under andre elementer uavhengig av hvilket nivå i hierarkiet/seksjonene)

  • Nummerert liste - 
    <OrderedList>

  • Unummerert liste - 
    <UnorderedList>

Parvis opplisting (navn - verdi) 
<NameValue>

For å presentere registerinnhold på en oversiktlig måte hvor det er naturlig å liste opp opplysninger med ledetekst og tilhørende verdi, gjerne flere etter hverandre.

Passer best for korte, konsise opplysninger og ikke lange tekster og setninger.

  • Lager en opplisting hvor ledetekstene kommer i en kolonne og verdien i den andre

  • Kan brukes hvor som helst i strukturen (over og under andre elementer uavhengig av hvilket nivå i hierarkiet/seksjonene)

  • Parverdi -
    <Pair name="X" value="Y">

Tabell 
<Table>

For å presentere registerinnhold hvor de kommer mest oversiktlig frem gjennom et tradisjonelt tabelloppsett med valgfritt antall kolonner og rader. 

Passer best for korte, konsise opplysninger og ikke lange tekster og setninger.

  • Lager en tabellpresentasjon av innholdet


  • Overskriftsrad i tabellen - 
    <Header>
    - valgfritt om benytte denne eller ikke

  • Øvrige rader - 
    <Row>

  • Kolonner/celler - 
    <Cell>

Vanlig løpende tekst 
<Text>

For å presentere registerinnhold i i form av løpende tekst, med mulighet for å bruke enkel formatering som fremhevet og nedtonet tekst i tillegg til linjeskift


  • Kan brukes hvor som helst i strukturen (over og under andre elementer uavhengig av hvilket nivå i hierarkiet/seksjonene)

  • Kan brukes alene

  • Kan også brukes inni andre elementer, men ikke i:

    • Tabeller

    • Parvis opplisting

Styres av verdi på ett eller flere attributter på Text-elementet:

  • “paragraph” (Nytt avsnitt, linjeskift før og etter) - 
    <“paragraph” = “true”>

  • “highligted” tekst (tidligere emphasized) - 
    <“highlighted” ="true">

  • “toned-down” tekst (tidligere italic) -
    <toned-down” = "true">

  • “newline” - (tidligere break)
    <newline="true">

 Støtteinformasjon og veiledning til innbygger slik at presentasjonen av registerinnholdet blir selvforklarende

Støtteinformasjon og veiledning til innbygger slik at presentasjonen av registerinnholdet blir selvforklarende

Registerinnhold er ikke alltid enkelt å forstå for innbyggere. Det er derfor viktig å legge til støtteinformasjon, veiledning  og beskrivelser til innbygger utover det spesifikke registerinnholdet. Det finnes derfor noen alternativer i innsynsformatet som kan benyttes for å legge til dette.

Elementtype

Til hva / når brukes dette

Nærmere beskrivelse

Regler

Alternativer og detaljer

Eksempel på bruk og utseende

Ordforklaringer 

Hvis innsynet inneholder spesifikke termer og begrep som den vanlige "mannen i gata" ikke forstår bør disse forklares. Da vil bruker få opp en utfyllende forklaring slik at det blir enklere å forstå.

  • Ordene som skal forklares legges inn samlet ett sted i XML-filen

  • I det øvrige registerinnholdet refereres det til aktuell forklaring. På denne måten kan samme forklaring benyttes flere steder i visningen.

  • Kan refereres til fra enkeltord eller delmengde av tekst i alle elementer

  • Selve ordforklaringen det refereres til legges inn en gang og kan henvises til fra ett eller flere steder i innholdet der de skal vises. Fortrinnsvis kun de begrepene som er relevant for aktuelt innsyn som inkluderes i responsen, spesielt hvis det finnes mange ordforklaringer totalt for registret.


Veiledningstekster

Brukes når du skal beskrive, veilede og forklare innholdet som kommer under 

  • Lager en tekstblokk som det er enkelt å se at ikke er en del av selve registerinnholdet

  • Kan brukes hvor som helst i strukturen (over og under andre elementer uavhengig av hvilket nivå i hierarkiet/seksjonene)

  • Teksten kan ikke formateres utover å definere linjeskift og eventuelle ordforklaringer


Versjoner av formatet

Formatet kan utvides med flere muligheter i nyere versjoner, men vi sørger for at vi er bakoverkompatible slik at det fremdeles er mulig å bruke eldre versjoner, men da uten mulighet til å benytte det nye som er kommet i nyere versjoner.

Oversikt over versjoner:

  • 5.1 (skal ikke benyttes lenger)

  • 5.2

    • Mulighet for veiledningstekst

    • Mulighet for ordforklaringer

    • Endret formatering instruksjoner for tekst til mer generiske verdier

Alle skjemaer finnes på undersiden: https://helsenorge.atlassian.net/wiki/spaces/HU/pages/1686208513

Hvordan teste dette?

Det er laget en egen side/test-tjeneste hvor du kan laste opp din formaterte XML-fil for å teste og verifisere hvordan det vil se ut og bli presentert på Helsenorge. På Helsenorge vil responsen vises for innbygger og formateres tilpasset innbyggers device.

Det finnes også nyttige lenker til detaljert dokumentasjon og eksempler direkte på testsiden.

Merk! Testsiden krever, på samme måte som alle integrasjoner, at aktørens system (IP-adresse) er whitelistet mot Helsenorges testsystemer.

Testside for innsynsformatet

Teknisk dokumentasjon

Registeret sender en XML-fil som har en bestemt struktur som er definert i en XSD-fil som er tilgjengelig fra Helsenorge.

XMLen som sendes for hvert enkelt innsyn blir parset av systemet og det genereres presentasjonskode som viser disse dataene i tråd med Helsenorges mal for presentasjon.

Detaljert informasjon om alle muligheter og det som trengs for å implementere innsynsformatet får du ved å se på de aktuelle skjemaene som finnes på undersiden: https://helsenorge.atlassian.net/wiki/spaces/HU/pages/1686208513

  • No labels