Oppgave API
Dette er et API som kan benyttes til forskjellige type oppgaver en helseaktør ønsker at innbygger skal utføre.
Dette API’et kan benyttes for å sende en oppgave til innbygger, og eventuelt i ettertid endre utvalgte parametere på en oppgave som allerede er innsendt.
Alle oppgaver til innbygger er modellert som en FHIR ressurs av type Task. For skjemaoppgaver kan oppgaven også inneholde andre FHIR ressurser i en FHIR Bundle. Men, selve oppgaven er alltid en FHIR Task.
Gjennom bruk av FHIR-ressurser har vi lagt til rette for at aktøren kan benytte forskjellig teknologi for integrasjon. Aktøren velger om man ønsker å benytte meldingsbasert integrasjon eller FHIR API.
Forutsetninger for bruk av Hendelsesvarsel (under utarbeidelse):
Følgende aktører kan bruke tjenesten:
Offentlig helseaktør, eller aktør med offentlig avtale
Aktører med tjenester på Helsenorge
API-navn | Oppgave |
---|---|
Funksjonelt område | Oppgave |
API-versjon og dato publisert | v1.0 Oct 27, 2020 |
Status | I drift |
API-dokumentasjon sist endret | Feb 11, 2021 |
Teknologi | REST + FHIR AMQP + FHIR |
Forretningsbehov
Prosesser og flyt
Innsending av Oppgave
Payload
En oppgave er alltid representert med en FHIR Task: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/742948883
I skjemaløsningen kan det i tilleg sendes med andre FHIR ressurser. Det skjer da som en FHIR Bundle (der et av elementene må være en Task). Se detaljer om dette her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1008369665
REST API
Det benyttes sikkerhetsmodell system-til-system: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1886191617
AksessToken inkluderes i header i etterfølgende HTTP-kall til API’et:
(HTTP POST): Helsenorge bestemmer ressursens ID.
URL til REST API:
Dersom Payload er bare Task:
POST [baseUrl for ekstern-API til HN-system]
/oppgave/v1/TaskDersom Payload er en Bundle (opsjon i Skjemaløsningen):
POST [baseUrl for ekstern-API til HN-system]
/oppgave/v1 (Med Body = Bundle)
Se her for oversikt over baseURL’er til de forskjellige systemene:
Meldingsbasert integrasjon (AMQP)
Sending av Hendelsesvarsel kan også skje ved meldingsbasert integrasjon. (Vil først implementeres når første aktør har slik behov). Hodemeldingen inneholder da eksakt samme “payload” som det som postes i REST-API’et.
Se prinsippene for meldingsbasert integrasjon med FHIR API’er på helsenorge:
Struktur på AMQP-melding ved meldingsbasert integrasjon
Støtte for kommunikasjonsprosessen i Adresseregisteret
Eksempel på bruk av FHIR Task i Hodemelding
Generell info om meldingsutveksling med Helsenorge
For overordnet informasjon om meldingsutveksling med Helsenorge se her:
Feilsituasjoner og feilkoder
Se her for informasjon om feilkoder ved innsending og oppdatering av oppgaver: