Innledning

Skjemaløsningen på Helsenorge tilbyr aktører å sende inn skjemaoppgaver som refererer til at skjemaet skal fylles ut av innbygger i et eksternt system. I denne dokumentasjonen kalles et slikt system for “ekstern skjemautfyller”. Når innbygger velger å utføre oppgaven (starte utfylling av skjema), tilrettelegges det for at innbygger skal oppleve en mest mulig sammenhengende flyt, selv om både Helsenorge og et eksternt system er involvert i oppgaveløsingen. Dette for å oppnå en god brukeropplevelse, og for å etterleve Prinsipper for innbyggertjenester - kobling mellom Helsenorge og andre løsninger i markedet. (Se prinsipp 2 og 3 om hhv. personverninnstillinger og oversikt.)

Krav til ekstern skjemautfyller

Generelle kvalitetskrav for integrasjonspartnere er angitt her: Kvalitetskrav til integrasjonspartnere

Spesifikt for eksterne skjemautfyllere

1. Allment aksepterte krav for brukskvalitet skal oppfylles, herunder at løsningen er universelt utformet og fungerer på mobile enheter.

2. Lover og forskrifter samt “Normens” krav knyttet til personvern og sikkerhet skal være ivaretatt.

3. Innbyggeren skal slippe å logge inn på nytt ved overgang til den eksterne skjemautfylleren.

   1. Ekstern skjemautfyller skal benytte Helsenorge OpenID Connect provider for å fastslå innbyggers identitet Se her om denne løsningen: 03 - Innbygger innlogging - Helsenorge som OpenID Connect provider

   2. Innbyggers utlogging fra ekstern skjemautfyller skal ikke medføre at innbygger logges ut av Helsenorge (vises p.t. to ulike faner)

4. Den eksterne skjemautfylleren skal presentere det aktuelle skjemaet for innbygger direkte, uten behov for ytterligere navigasjon.

5. Ekstern skjemautfyller skal understøtte at pasienten representeres av en annen innlogget innbygger.

   1. Helsenorge OpenID Connect provider gir informasjon om både representert innbygger og innlogget innbygger, samt type representasjonsforhold. Denne informasjonne skal i så fall benyttes.

   2. Det skal framgå i den eksterne skjemautfylleren hvem som er innlogget og hvem som er pasienten.

   3. Det skal framgå i skjemasvaret hvem som har fylt ut skjemaet dersom det ikke er pasienten selv.

6. Ekstern skjemautfyller skal levere en kopi av utfylt skjema til innbyggers helsearkiv på Helsenorge.

   1. Detaljert teknisk dokumentasjon av FHIR-ressursene og XML-eksempler finnes her: Teknisk detalj dokumentasjon - skjemaløsning

7. Ekstern skjemautfyller skal ha oppetid, tilgjengelighet og drift som for Helsenorge, i praksis 24/7 tilgjengelighet og drift og det skal være tydelig hvem som kontaktes ved tekniske og funksjonelle feil.

8. Ekstern skjemautfyller skal ha responstider som for Helsenorge, med 99% av alle sidevisninger med responstid på under 2s

9. Ekstern skjemautfyller skal være skalert og ytelsestestet forventet volum av bruk.

10. Ekstern skjemautfyller skal ha etablert testmiljø integrert med Helsenorge og tilgjengelig for ende til ende funksjonell og tekniisk verifisering

Ekstern skjemautfyller sender ferdig utfylt skjema til Helsenorge

Denne funksjonaliteten er kun tilgjengelig dersom utfylling er resultat av en skjemaoppgave (dvs. FHIR Task).

Payload

Det er to varianter av payload, der kun den ene er implementert så langt (se Bruksscenarier):

• Ekstern skjemautfyller sender selv skjemasvar til aktør og sender kun lesbar kopi av svaret til innbygger på Helsenorge: FHIR DocumentReference med PDF Se her for detaljer

• MERK Ikke implementert enda: Dersom Helsenorge skal formidle skjemasvar til aktør, sender ekstern skjemautfyller både skjemasvar i sitt eget (proprietære) format samt innbyggers lesbare kopi i en FHIR Bundle: Se her for detaljer

  • Dette siste er et bruksscenarie som ikke er support for enda (høst 2023), implementeres avhengig av behov fra sektoren.

REST API

Autorisasjon

To metoder for tilgang er tilgjengelige:

1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

   1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

   2. Velg deretter scope “Skjema”

   3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

   1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

   2. Fullmaktinformasjon API-et skal benyttes i system-til-system kontekst: 01 - System til System

   3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken

Bruk av API’et

Her skal det benyttes Create - HTTP POST FHIR - REST Operasjoner | Create HTTP POST

• Create (HTTP POST): Her bestemmer Helsenorge ressursens ID. (Hvis kun PDF)

  • Eks: POST [base]/skjema/v1/DocumentReference

Meldingsbasert integrasjon (AMQP)

Innsending av skjemasvar fra ekstern skjemautfyller til Helsenorge som Hodemelding med FHIR DocumentReference eller en FHIR Bundle er beskrevet her: AMQP Skjemautfyller

(Opsjon) Ekstern skjemautfyller mellomlagrer delvis utfylt skjema på Helsenorge

Denne funksjonaliteten er kun tilgjengelig dersom utfylling er resultat av en skjemaoppgave (dvs. FHIR Task). Brukes kun i samråd med Helsenorge i tilfeller der mellomlagring er hensiktsmessig.

• Ekstern skjemautfyller antas å ha proprietært format for delvis utfylt skjema. Dette lagres derfor alltid som en binær octetstreng på Helsenorge og representeres via FHIR ressursen: FHIR DocumentReference

• Ekstern skjemautfyller skal alltid benytte Create - FHIR - REST Operasjoner | Create HTTP POST

• Når ekstern skjemautfyller skal hente ut mellomlagret skjema igjen, kan den benytte to forskjellige “patterns”:

  • Dersom den tar vare på ressursens ID som returneres fra Helsenorge kan denne benyttes i en Read - HTTP GET: FHIR - REST Operasjoner | Read HTTP GET

  • Ressursen kan hentes ut igjen med en Search - HTTP POST (_search), der man benytter kjente verdier som er lagret i elementer på ressursen (her DocumentReference) FHIR - REST Operasjoner | Search HTTP POST (_search)

REST API

Lagring av delvis utfylt skjemasvar

Det benyttes sikkerhetsmodell med System-til-system: 01 - System til System

Lagre skjemainstans: Create (HTTP POST): Her bestemmer Helsenorge ressursens ID. FHIR - REST Operasjoner | Create HTTP POST

• Eks: POST [base]/skjema/v1/DocumentReference

Uthenting av tidligere mellomlagret delvis utfylt skjemasvar

Det benyttes sikkerhetsmodell med System-til-system: 01 - System til System

Pattern 1: Ekstern skjemautfyller “husker” mellomlagret dokument sin ressurs ID slik denne ble returnert fra Helsenorge

Hente skjemainstans: Read (HTTP GET): Lagret skjemainstans hentes direkte basert på ressurs ID. FHIR - REST Operasjoner | Read HTTP GET

• Eks: GET [base]/skjema/v1/DocumentReference/fe0e4d02-0d0a-43be-8784-0ac336fefec3

Pattern 2: Ekstern skjemautfyller husker ikke ressursens id, men må søke opp mellomlagret dokument

• Hente lagret dokument: Search (HTTP POST): Her kan det benyttes verdier i elementer i DocumentReference som ekstern skjemautfyller kjenner. FHIR - REST Operasjoner | Search HTTP POST (_search)

  • POST [base]/skjema/v1/DocumentReference/_search

    • Body: Eks 1: Man kjenner innbyggers fødselsnummer og oppgavens (task) sin identifier:

• Ikke implementert enda: Body: Eks 2: Man benytter/kjenner DocumentReference.identifier

Meldingsbasert integrasjon (AMQP)

• Denne funksjon<liteten tilbys ikke med meldingsformidling.