Husk å legg til etiketten “api-dokumentasjon” når denne malen benyttes, samt å slette denne notisen
Note
Skjemaløsningen på Helsenorge er en generell tjeneste der innbygger kan fylle ut et skjema og utfylt skjema kan sendes til en eller flere mottagere. Opprinnelig ble prosessen alltid startet med at innbygger fikk en skjemaoppgave. Prosessene og meldingene som er beskrevet her er basert på første implementasjon av løsningen og ønskes erstattet.
Expand
title
Ny løsning
Ny mer generell implementasjon består av tre ulike prosesser som kan være uavhengige av hverandre:
Dialog Oppgaveforespørsel: Generell dialog prosess der en ekstern aktør kan be om at innbygger utfører en bestemt oppgave. Dette kan være flere typer oppgave. Hva oppgaven innebærer styres av den ressurs oppgaven referer til. For «skjemaoppgaver» vil dette være referanse til et FHIR Questionnaire.
Dialog Skjemainnsending: En kommunikasjonsprosess der Helsenorge på vegne av innbygger sender et ferdig utfylt skjema til en (eller flere) mottagere. Utfylt skjema vil normalt være en FHIR QuestionnaireResponse. (Det understøttes også andre formater for ferdig utfylt skjema, men disse må i så fall på forhånd være avtalt mellom den som er mottager av utfylt skjema og den skjemautfyller som benyttes. Helsenorge sin egen skjemautfyller benytter alltid FHIR ressurser.)
Dialog Skjemautfyller: En kommunikasjonsprosess der en ekstern skjemautfyller kan formidle et skjema som innbygger har fylt ut til Helsenorge for videre behandling. Videre behandling vil normalt være å lagre utfylt skjema for inbygger på Helseorge, men kan også innebære at Helsenorge sender utfylt skjema til en eller flere mottagere.
Prosessen Dialog Oppgave inneholder flere ulike funksjoner knyttet til skjemaoppgaver:
Med skjemaoppgave til utfylling kan helsepersonell sende et skjema til innbygger.
Med skjemaoppgave ferdigstilt kan en skjemautfyller sende et ferdig utfyllt skjema til innbygger på helsenorge.no.
Med skjemaoppgave til innsending kan helsenorge.no sende et ferdig utfylt skjema til en skjemamottaker. Dette kan være den som sendte skjema til innbygger eller en annen mottaker.
Page Properties
API-navn
DIALOG_INNBYGGER_OPPGAVE
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.1
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Prosesser og flyt
Her er info om prosesser og flyt
Expand
title
Overordnet flyt og sekvensdiagrammer
Følgende prosesser skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Oppgave
Basisversjon for kommunikasjonsprosess
1.1
Tabellen under viser hvilke roller som inngår i prosessen, hvilke funksjoner de ulike rollene kan gjøre og hvilke meldinger som benyttes for de ulike versjonene.
Versjon
Rolle
Funksjon
Meldingsinnhold
1.1
Innbygger
TilInnsending (A)
Applikasjonskvittering (A)
Dialogmelding 1.1
Helsepersonell
TilUtfylling (A)
Ferdigstill
Applikasjonskvittering (A)
Dialogmelding 1.1
Prosessen Dialog Oppgave inneholder flere ulike funksjoner knyttet til skjemaoppgaver. Sekvensdiagram for de ulike funksjonene er vist under.
Skjemaoppgave til utfylling:
Image Removed
Skjemaoppgave ferdigstilt:
Image Removed
Skjemaoppgave til innsending:
Image Removed
Forespørsel om ???
Her er strukturen på query
Expand
title
Struktur på query
Svar på forespørsel om ???
Her er strukturen på en respons
Expand
title
Struktur på response
Note
Skjemaløsningen på Helsenorge er en generell tjeneste der innbygger kan fylle ut et skjema og utfylt skjema kan sendes til en eller flere mottagere. Opprinnelig ble prosessen alltid startet med at innbygger fikk en skjemaoppgave. Prosessene og meldingene som er beskrevet her er basert på første implementasjon av løsningen og ønskes erstattet.
Expand
title
Ny løsning
Ny mer generell implementasjon består av tre ulike prosesser som kan være uavhengige av hverandre:
Dialog Oppgaveforespørsel: Generell dialog prosess der en ekstern aktør kan be om at innbygger utfører en bestemt oppgave. Dette kan være flere typer oppgave. Hva oppgaven innebærer styres av den ressurs oppgaven referer til. For «skjemaoppgaver» vil dette være referanse til et FHIR Questionnaire.
Dialog Skjemainnsending: En kommunikasjonsprosess der Helsenorge på vegne av innbygger sender et ferdig utfylt skjema til en (eller flere) mottagere. Utfylt skjema vil normalt være en FHIR QuestionnaireResponse. (Det understøttes også andre formater for ferdig utfylt skjema, men disse må i så fall på forhånd være avtalt mellom den som er mottager av utfylt skjema og den skjemautfyller som benyttes. Helsenorge sin egen skjemautfyller benytter alltid FHIR ressurser.)
Dialog Skjemautfyller: En kommunikasjonsprosess der en ekstern skjemautfyller kan formidle et skjema som innbygger har fylt ut til Helsenorge for videre behandling. Videre behandling vil normalt være å lagre utfylt skjema for inbygger på Helseorge, men kan også innebære at Helsenorge sender utfylt skjema til en eller flere mottagere.
Prosessen Dialog Oppgave inneholder flere ulike funksjoner knyttet til skjemaoppgaver:
Med skjemaoppgave til utfylling kan helsepersonell sende et skjema til innbygger.
Med skjemaoppgave ferdigstilt kan en skjemautfyller sende et ferdig utfyllt skjema til innbygger på helsenorge.no.
Med skjemaoppgave til innsending kan helsenorge.no sende et ferdig utfylt skjema til en skjemamottaker. Dette kan være den som sendte skjema til innbygger eller en annen mottaker.
Page Properties
API-navn
DIALOG_INNBYGGER_OPPGAVE
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.1
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Prosesser og flyt
Her er info om prosesser og flyt
Expand
title
Overordnet flyt og sekvensdiagrammer
Følgende prosesser skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Oppgave
Basisversjon for kommunikasjonsprosess
1.1
Tabellen under viser hvilke roller som inngår i prosessen, hvilke funksjoner de ulike rollene kan gjøre og hvilke meldinger som benyttes for de ulike versjonene.
Versjon
Rolle
Funksjon
Meldingsinnhold
1.1
Innbygger
TilInnsending (A)
Applikasjonskvittering (A)
Dialogmelding 1.1
Helsepersonell
TilUtfylling (A)
Ferdigstill
Applikasjonskvittering (A)
Dialogmelding 1.1
Prosessen Dialog Oppgave inneholder flere ulike funksjoner knyttet til skjemaoppgaver. Sekvensdiagram for de ulike funksjonene er vist under.
Skjemaoppgave til utfylling:
Image Added
Skjemaoppgave ferdigstilt:
Image Added
Skjemaoppgave til innsending:
Image Added
Forespørsel om skjemaoppgave til utfylling
Forespørsel om skjemaoppgave til utfylling fra helsepersonell til innbygger.
Expand
title
Struktur på melding
Tjeneste
Forespørsel om utfylling av skjemaoppgave til innbygger
Bruksområde
Brukes når en skjemautsender skal sende en skjemaoppgave til innbygger
Hodemelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.3
Obligatorisk verdi i MsgHead/MsgInfo/Type er:
Code Block
<Type V="DIALOG_INNBYGGER_OPPGAVE" DN="Skjematjeneste for innbygger"/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<Ack DN="Ja" V="J"/>
Dialogmelding
Obligatoriske elementer (klasse/element):
Dialogmelding/Foresporsel/TypeForesp
Dialogmelding/Foresporsel/EmneSporsmal
Dialogmelding/Foresporsel/Sporsmal
Lovlige kodeverdier som kan brukes i TypeForesp:
SKOU – Skjemaoppgave til utfylling
XML eksempel:
Code Block
<Foresporsel>
<TypeForesp V="SKOU" DN="Skjemaoppgave til utfylling" S="2.16.578.1.12.4.1.1. 7601"/>
<EmneSporsmal>Beskrivende emne som leses av innbygger</Sporsmal>
<Sporsmal>Beskrivende innhold/skjemainstruksjoner</Sporsmal>
</Foresporsel>
RollerRelatertNotat
Benyttes ikke for denne prosessen
iCalender
Ikke aktuelt å bruke for denne tjenesten.
Helsepersonell
Ikke aktuelt å bruke for denne tjenesten.
Pasientrelasjon
Ikke aktuelt å bruke for denne tjenesten.
Vedlegg
Ikke aktuelt å bruke for denne tjenesten.
Map
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.10.
Obligatoriske elementer i Metadata-seksjonen:
Deadline
SchemaName
Valgfrie elementer i Metadata-seksjonen:
ResourceType
Påkrevet når NHNs skjemakatalog benyttes
Tag
Påkrevet når NHN skjemakatalog benyttes
ExternalId
Påkrevet når integrasjonsparten benytter egen skjemakatalog/skjemautfyller
ExternalUri
Påkrevet når integrasjonsparten benytter egen skjemakatalog/skjemautfyller
Utelates når E-helses skjemautfyller benyttes
Reminder
ValidTo
SupportsRepresentation
DescriptionAboutReceivers
RenditionOfSchema
Lovlige kodeverdier som kan benyttes i ResourceType:
Questionnaire
Lovlig format i Tag:
{key}|{value}
Obligatoriske elementer i ContactInformation-seksjonen:
Name
PhoneNumber
Organization
Valgfrie elementer i ContactInformation-seksjonen:
Det ikke-standardiserte informasjonsobjektet brukes for å angi metadata om oppgaven som er mottatt, eksempelvis URI til eksternt skjemaverktøy, frist, prosessknytninger, kontaktinformasjon, mottakere, osv.
MERK: Under utviklingen av piloten har man valgt å benytte seg av et dynamisk informasjonsobjekt pga. uklarheter rundt hvilke data som ønskes utvekslet. Det må derfor antas at informasjonsobjektet vil bli endret til et standardisert informasjonsobjekt før man går i produksjon med piloten.
Tillatte datatyper:
Integer
String
Date
Enums
Datatypen Date skal formateres i henhold til standarden ISO-8601, 2016-06-26 (YYYY-MM-DD). Et XML-eksempel er vist under.
Feltene i formatet er beskrevet nærmere i dette avsnittet.
Diverse tekniske og funksjonelle data relatert til utfylling av skjemaet.
Felt
Obligatorisk
Beskrivelse
ExternalId
Nei
Skjemaets eksterne identifikator
ExternalUri
Nei
Url til ekstern utfyller
Deadline
Ja
Ønsket frist for innlevering av skjemaoppgave. Dersom ValidTo ikke er spesifisert skal ValidTo settes lik Deadline.
ValidTo
Nei
Absolutt frist for innlevering av skjemaoppgave. Etter denne datoen er passert er det ikke mulig å sende inn.
Reminder
Nei
Påminnelse må minimum settes en dag før Deadline
SupportsRepresentation
Nei
Dersomekstern utfyller støtter utfylling av skjema ved representasjon skal dette flagget settes til true. Dersom flagget ikke er satt er standardverdien false.
CanBePerformedBy
Nei
Indikerer om skjemaet kun kan fylles ut av innbygger selv. Dersom flagget ikke er satt er standardverdien false.
· 1 = Standardoppførsel
· 2 = Kun innbygger selv kan fylle ut skjemaet
SchemaName
Ja
Det funksjonelle navnet til skjemaet, dette vises til innbygger.
DescriptionAboutReceivers
Nei
Beskrivelse av foretak og individer som skal motta det ferdige utfylte skjemaet og formålet for innhenting av data.
AccessibilityToResponse
Nei
Angir innbygger tillates tilgang til resultatet i etterkant. Dette gjelder både de strukturerte data, samt PDF-versjon.
· 1 = Standardoppførsel
· 2 = Innbygger og ekstern mottaker har tilgang til skjemaet
· 3 = Kun ekstern mottaker har tilgang til skjemaet
UseContext
Nei
Angir bruksområdet for oppgaven. I tillegg til informasjon om bruksområdet vil dette også benyttes for å tilgangsstyre skjemaet opp mot samtykkeområdene som er angitt på Helsenorge.
RenditionOfSchema
Nei
Attributtet er fjernet, benytt attributtet AccessibilityToResponse.
NotificationTextCode
Nei
Angir den predefinerte teksten, inkl. aktørens navn, som kan benyttes ved utsending av skjemaoppgaver. Ved bruk av dette feltet må SensitiveInformation være angitt og satt til ‘false’.
· 1 = Varsel om nytt skjema til utfylling fra aktør
· 2 = Invitasjon til deltakelse i spørreundersøkelse fra aktær
· 3 = Innhenting av samtykke fra aktør
· 4 = Skjema med informasjon fra aktør
SensitiveInformation
Nei
Må angis og verdien settes til ‘false’ dersom NotificationTextCode benyttes. Flagget angir at du som avsender bekrefter at informasjonen i ‘ContactInformation’-seksjonen er ikke-sensitiv og kan benyttes i SMS og e-post.
Seksjonen ContactInformation inneholder informasjon om foretak, avdeling og telefonnummer til det kontaktpunktet som skal brukes når det er behov for hjelp til utfylling av skjema.
Felt
Beskrivelse
Organization
Navn på den enheten av som kan svare på spørsmål angående utfylling av skjemaet.
Name
Navn på enkeltperson som kan svare på spørsmål om utfylling av skjemaet, for eksempel fastlege. Benyttes ikke i dag.
Role
Rolle til den enkeltpersonen som kan svare på spørsmål om utfylling av skjemaet, for eksempel fastlege. Benyttes ikke i dag.
PhoneNumber
Telefonnumer innbygger kan benytte ved spørsmål angående utfylling av skjemaet.
DescriptionAboutPointOfContact
Utfyllende beskrivelse av kontaktpunkt ved spørsnål om utfylling av skjemaet.
Seksjonen Recipients benyttes for å beskrive hovedmottakere og andre mottakere av skjema. Skjemaløsningen vil benytte seg av denne informasjonen til å videreformidle ferdigstilt skjemainstans med rendition til angitte mottakere.
Felt
Beskrivelse
Recipient
Kompleks struktur som referer til angitte mottakere.