- Created by Levin Løssfelt (Unlicensed), last modified on Jun 25, 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
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.
Ny mer generell implementasjon består av tre ulike prosesser som kan være uavhengige av hverandre:
Dialog Oppgaveforespørsel AMQP 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 AMQP 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 AMQP 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.
API-navn | DIALOG_INNBYGGER_OPPGAVE |
---|---|
Funksjonelt område | Dialog |
API-versjon og dato publisert | v1.1 |
Status | I DRIFT |
API-dokumentasjon sist endret |
|
Teknologi | AMQP |
Prosesser og flyt
Her er info om prosesser og flyt
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:
Skjemaoppgave ferdigstilt:
Skjemaoppgave til innsending:
Forespørsel om skjemaoppgave til utfylling
Forespørsel om skjemaoppgave til utfylling fra helsepersonell til innbygger.
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 Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: <Type V="DIALOG_INNBYGGER_OPPGAVE" DN="Skjematjeneste for innbygger"/> Obligatorisk verdi i MsgHead/MsgInfo/Ack er: <Ack DN="Ja" V="J"/> |
Dialogmelding | Obligatoriske elementer (klasse/element):
Lovlige kodeverdier som kan brukes i TypeForesp:
XML eksempel: <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 under Innholdsstandarder for (skjema)oppgave - Ikke-standardisert informasjonsobjekt «Map» lenger ned på denne siden. Obligatoriske elementer i Metadata-seksjonen:
Valgfrie elementer i Metadata-seksjonen:
Lovlige kodeverdier som kan benyttes i ResourceType:
Lovlig format i Tag:
Obligatoriske elementer i ContactInformation-seksjonen:
Valgfrie elementer i ContactInformation-seksjonen:
Recipients-seksjonen er valgfri
XML-eksempel, se varianter under: <Map> <Entry Key="Metadata"> <Value Key="ExternalId">123</Value> <Value Key="ExternalUri">http://tool.uri/?id={id}</Value> <Value Key="QuestionnaireName">Navn på skjema til utfylling</Value> <Value Key="Deadline">2016-07-15</Value> <Value Key="Reminder">2016-07-12</Value> <Value Key="DescriptionAboutReceivers">Tekst som beskriver mottakere</Value> </Entry> <Entry Key="ContactInformation"> <Value Key="Name">Lege Legesen</Value> <Value Key="PhoneNumber">99887766</Value> <Value Key="Organization">HF Sykehus</Value> <Value Key="Role">Overlege</Value> <Value Key="DescriptionAboutPointOfContact">Mer utdypende informasjon om kontaktpunkt</Value> </Entry> <Entry Key="Recipients"> <Reference Ref="Recipient/98876" /> <Reference Ref="Recipient/98877" /> </Entry> <Contained Key="Recipient/98876"> <Recipient ReceiverType="MainReceiver"> <Ident> <Id>98876</Id> <TypeId DN="HER-id" V="HER " S=" 2.16.578.1.12.4.1.1.9051" /> </Ident> </Recipient> </Contained> <Contained Key="Recipient/98877"> <Recipient ReceiverType="OtherReceiver"> <Ident> <Id>98877</Id> <TypeId DN="HER-id" V="HER " S=" 2.16.578.1.12.4.1.1.9051" /> </Ident> </Recipient> </Contained> </Map>
XML-eksempel når E-helses skjemakatalog og skjemautfyller benyttes: <Map> <Entry Key="Metadata"> <Value Key="ResourceType">Questionnaire</Value> <Value Key="Tag">http://ehelse.no/questionnaire-definition|questionnaire-v1.0</Value> (…) </Entry> (…) </Map>
XML-eksempel når integrasjonspart bruker egen skjemakatalog og skjemautfyller: <Map> <Entry Key="Metadata"> <Value Key="ExternalId">123</Value> <Value Key="ExternalUri">http://tool.uri/?id={id}</Value> (…) </Entry> (…) </Map> |
Skjemamodell | Valgfritt element, og benyttes i henhold til beskrivelse under Informasjonsmodeller for utveksling av skjemainnhold lenger ned på denne siden. |
Skjemadata | Ikke aktuelt å benytte for denne tjenesten. |
Bundle | Obligatorisk dersom meldingsutvekslingen inneholder minimum to FHIR-ressurser. |
Resource references | Valgfrie elementer, kan benyttes dersom man ønsker å utveksle berikingsinnhold. |
Self-contained resources | Ikke aktuelt å benytte for denne tjenesten. |
Forespørsel om skjemaoppgave ferdigstilt
Resultat av utfylling av skjema fra helsepersonell til innbygger.
Tjeneste | Ferdig utfylt skjema til innbygger (kopi) |
Bruksområde | Brukes fra skjemautfyller når innbygger ferdigstiller skjemaet |
Hodemelding | Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: <Type V="DIALOG_INNBYGGER_OPPGAVE" DN="Skjematjeneste for innbygger"/> Obligatorisk verdi i MsgHead/MsgInfo/Ack er: <Ack DN="Ja" V="J"/> |
Dialogmelding | Obligatoriske elementer (klasse/element):
Lovlige kodeverdier som kan brukes i TypeForesp:
XML-eksempel: <Foresporsel> <TypeForesp V="SKIF" DN="Skjemainstans ferdigstilt" S="2.16.578.1.12.4.1.1. 7601"/> </Foresporsel> |
iCalender | Ikke aktuelt å bruke for denne tjenesten. |
Helsepersonell | Ikke aktuelt å bruke for denne tjenesten.
|
Pasientrelasjon | Ikke aktuelt å bruke for denne tjenesten.
|
Vedlegg | Valgfri informasjon som skal være med dersom det er tillatt for innbygger å motta kopi av utfylt skjema. Se Vedlegg for korrekt bruk. |
Map | Obligatorisk element:
XML-eksempel: <Map> <Entry Key="Metadata"> <Value Key="ExternalId">123</Value> </Entry> </Map> |
Skjemamodell | Ikke aktuelt å benytte for denne tjenesten. |
Skjemadata | Valgfri informasjon. Benyttes dersom skjemautsender og skjemautfyller støtter utveksling av skjemainnhold. Benyttes i henhold til informasjonsmodeller for utveksling av skjemainnhold under Ytterligere informasjon på denne siden. |
Bundle | Ikke aktuelt å benytte for denne tjenesten. |
Resource references | Ikke aktuelt å benytte for denne tjenesten. |
Self-contained resources | Ikke aktuelt å benytte for denne tjenesten. |
Skjemaoppgave til innsending
Innsending av skjemaoppgave fra innbygger.
Tjeneste | Forespørsel om utfylling av skjemaoppgave til innsending |
Bruksområde | Brukes av Helsenorge.no når ferdigstilte skjema som ble mottatt av SKIF skal sendes til kopimottakere av skjema. |
Hodemelding | Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: <Type V="DIALOG_INNBYGGER_OPPGAVE" DN="Skjematjeneste for innbygger"/> Obligatorisk verdi i MsgHead/MsgInfo/Ack er: <Ack DN="Ja" V="J"/> |
Dialogmelding | Obligatoriske elementer (klasse/element):
Lovlige kodeverdier som kan brukes i TypeForesp:
XML-eksempel: <Foresporsel> <TypeForesp V="SKOI" DN="Skjemaoppgave til innsending" S="2.16.578.1.12.4.1.1. 7601"/> <EmneSporsmal>PLACEHOLDER</Sporsmal> <Sporsmal>PLACEHOLDER</Sporsmal> </Foresporsel> |
iCalender | Ikke aktuelt å bruke for denne tjenesten. |
Helsepersonell | Ikke aktuelt å bruke for denne tjenesten. |
Pasientrelasjon | Ikke aktuelt å bruke for denne tjenesten. |
Vedlegg | Valgfri informasjon som skal være med dersom helsenorge mottok binært vedlegg fra skjemautfyller. |
Map | Obligatorisk Obligatoriske elementer:
XML-eksempel: <Map> <Entry Key="Metadata"> <Value Key="ExternalId">123</Value> </Entry> </Map> |
Skjemamodell | Ikke aktuelt å benytte for denne tjenesten. |
Skjemadata | Valgfri informasjon. Benyttes dersom støtter utveksling av skjemainnhold. Benyttes i henhold til informasjonsmodeller for utveksling av skjemainnhold under Ytterligere informasjon på denne siden. |
Bundle | Ikke aktuelt å benytte for denne tjenesten. |
Resource references | Ikke aktuelt å benytte for denne tjenesten. |
Self-contained resources | Ikke aktuelt å benytte for denne tjenesten. |
Generell info om meldingsutveksling med Helsenorge
For overordnet informasjon om meldingsutveksling med Helsenorge se her: Meldingsutveksling med Helsenorge og PVK
Ytterligere informasjon
Innholdsstandarder for (skjema)oppgave
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.
<Map> <Entry Key="Metadata"> <Value Key="ExternalId">123</Value> <Value Key="ExternalUri">http://tool.uri/?id={id}</Value> <Value Key="Deadline">2016-07-15</Value> <Value Key="Reminder">2016-07-12</Value> <Value Key="ValidTo">2016-07-18</Value> <Value Key="SupportsRepresentation">false</Value> <Value Key="SchemaName">Navn på skjema</Value> <Value Key="DescriptionAboutReceivers">Beskrivelse av mottakere og formålet for innhenting av data</Value> <Value Key="NotificationTextCode">2</Value> </Entry> <Entry Key="ContactInformation"> <Value Key="SensitiveInformation">false</Value> <Value Key="Name">Lege Legesen</Value> <Value Key="PhoneNumber">99887766</Value> <Value Key="Organization">HF Sykehus</Value> <Value Key="Role">Overlege</Value> <Value Key="DescriptionAboutPointOfContact">Utfyllende beskrivelse av kontaktpunkt ved spørsmål om utfylling av skjemaet</Value> </Entry> <Entry Key="Recipients"> <Reference Ref="Recipient/98876"> <Reference Ref="Recipient/98877"> </Entry> <Entry Key="UseContext"> <Reference Ref="UseContext/1"> <Reference Ref="UseContext/2"> </Entry> <Contained Key="Recipient/98876"> <Recipient ReceiverType="MainReceiver"> <Ident> <Id>98876</Id> <TypeId DN="HER-id" V="HER " S="2.16.578.1.12.4.1.1.9051"> </Ident> </Recipient> </Contained> <Contained Key="Recipient/98877"> <Recipient ReceiverType="OtherReceiver"> <Ident> <Id>98877</Id> <TypeId DN="HER-id" V="HER " S="2.16.578.1.12.4.1.1.9051"> </Ident> </Recipient> </Contained> <Contained Key="UseContext/1"> <UseContext DN="Helsehjelp knyttet til somatisk sykdom" V="S" S="2.16.578.1.12.4.1.1.8655"/> </Contained> <Contained Key="UseContext/2"> <UseContext DN="Hud veneriske sykdommer" V="S05" S="2.16.578.1.12.4.1.1.8655"/> </Contained> </Map>
Beskrivelse av seksjoner og felter
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 | Dersom ekstern 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. |
|
| 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. |
ReceiverType | Enum med verdiene MainReceiver og OtherReceiver. |
Identifikator fra angitt kodeverk | |
Ident.TypeId | Kodeverdi fra angitt kodeverk |
Informasjonsmodeller for utveksling av skjemainnhold
Denne seksjonen beskriver ulike informasjonsstandarder og -modeller som brukes for å utveksle skjemainnhold.
XML-eksempel for skjemamodell dersom modellen er beskrevet i XML-format. Eksempelet benytter FHIR:
<Document> <ContentDescription>schema-model</ContentDescription> <RefDoc> <MsgType V="XML" DN="XML-instans"/> <Id>84F96CD4-2556-4536-8266-9DCF933E0D62</Id> <Content> <Questionnaire xmlns="http://hl7.org/fhir"> (…) </Questionnaire> </Content> </RefDoc> </Document>
XML-eksempel for skjemamodell dersom modellen er beskrevet i et format som ikke er kompatibelt med XML:
<Document> <ContentDescription>schema-model</ContentDescription> <RefDoc> <MsgType V="A" DN="Vedlegg"/> <Id>84F96CD4-2556-4536-8266-9DCF933E0D62</Id> <Content> <Base64Container xsi:schemaLocation="http://www.kith.no/xmlstds/base64container kith-base64.xsd" xmlns="http://www.kith.no/xmlstds/base64container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Base64Container> </Content> </RefDoc> </Document>
XML-eksempel for skjemadata dersom formatet er beskrevet i XML. Eksempelet benytter FHIR:
<Document> <ContentDescription>schema-data</ContentDescription> <RefDoc> <MsgType V="XML" DN="XML-instans"/> <Id>807B68D0-76A5-4DC7-8099-CA60918D638E</Id> <Content> <Questionnaireresponse xmlns="http://hl7.org/fhir"> (…) </Questionnaireponse> </Content> </RefDoc> </Document>
XML-eksempel for skjemadata dersom formatet er beskrevet i format som ikke er kompatibelt med XML:
<Document> <ContentDescription>schema-data</ContentDescription> <RefDoc> <MsgType V="A" DN="Vedlegg"/> <Id>807B68D0-76A5-4DC7-8099-CA60918D638E</Id> <Content> <Base64Container xsi:schemaLocation="http://www.kith.no/xmlstds/base64container kith-base64.xsd" xmlns="http://www.kith.no/xmlstds/base64container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Base64Container> </Content> </RefDoc> </Document>
XML-eksempel for skjemagjengivelse (rendition) i PDF-format:
<Document> <ContentDescription>schema-rendition</ContentDescription> <RefDoc> <MsgType V="A" DN="Vedlegg"/> <MimeType>application/pdf</MimeType> <Description>Forståelig navn på skjema</Description> <Content> <Base64Container xsi:schemaLocation="http://www.kith.no/xmlstds/base64container kith-base64.xsd" xmlns="http://www.kith.no/xmlstds/base64container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Base64Container> </Content> </RefDoc> </Document>
- No labels