| Table of Contents |
|---|
| Page Properties | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
API'ets formål
API’et gjør det mulig å forskrive et Verktøy til innbygger direkte fra behandler-del av verktøyet eller fra EPJ. Når et verktøy forskrives, vil innbygger varsles og finne det forskrevne verktøyet under “Mine Verktøy” på Helsenorge. Dette er et alternativ til at behandler logger seg på Verktøyformidler for å forskrive verktøy til innbygger.
Fordeler med API'et
Dette gir en eklere prosess for behandler når verktøy skal forskrives. (Som alternativ til pålogging til Verktøyformidler).
Hvordan benytte API'et
Type API
REST
Metode og parametre til endepunktet
HTTP-verb: POST
Tjeneste: verktoy
Request
Tjenestenavn | Funksjon | Beskrivelse request | Eksempel | ||||
|---|---|---|---|---|---|---|---|
verktoy | Forskrivning av et bestemt verktøy til innbygger. Innbygger vil varsles på Helsenorge og finne forskrevet verktøy under “flisa” verktøy (se funksjonell beskrivelse av Digitale Verktøy). Verktøyet må være definert i Verktøykatalogen på forhånd, og verktøyets unike ID må være kjent i forskrivningsfunksjonen i Verktøyet. | VerktoyId: Verktøyets unike ID slik det er lagret i Verktøykatalogen (type Guid)
InnbyggerFnr: Innbyggers fødselsnummer (type string). Merk! det vil bli feilrespons dersom innbygger ikke er digital aktiv på Helsenorge. En av følgende to alternativer for å angi behandler som forskriver verktøyet:
| Eksempel JSON: HPR-nummer kjent i system som benytter API:
Kun behandlers fødselsnummer er kjent i systemet som benytter API’et:
|
Respons
Navn | Type | Beskrivelse |
|---|---|---|
PseudoId | string | Benyttes kun i eldre integrasjoner. Tom streng nå. |
Exceptions
Navn | HttpStatus | Beskrivelse |
|---|---|---|
FinnerIkkeBehandlerInfo | 400 | Finner ikke helsepersonellinformasjon på angitt hpr-nummer. |
LaeringsressursAlreadyPrescribedToInnbyggerBySameBehandler | 400 | Verktøy allerede forskrevet til innbygger av samme behandler |
LaeringsressursAlreadyPrescribedToInnbygger | 400 | Verktøy allerede forskrevet |
SendVerktoyPasientIkkeDigitaltAktiv | 400 | Innbygger er ikke digitalt aktiv på helsenorge |
NotFoundVerktoy | 400 | Finner ikke verktøy med angitt verktøy id |
CannotDeserializeErrorFromService | 500 | Dersom underliggende tjenester er nede |
Autentisering og autorisasjon
ForskrivningsAPI’et har ikke noen innlogget innbygger context, da forskrivning foretas av behandler eller i Helseforetaket. Vi har valgt å ikke kreve at forskriver er innlogget med HelseID for å benytte dette API’et, og tillater såkalt system-til-system kopling fra forskrivningsfunksjonen i Verktøyet og til Helsenorge API’et. AksessToken for å kalle ForskrivningsAPI’et fås fra Helsenorge sikkerhetstjeneste gjennom flyt beskrevet her: 01 - System til System - V2
Deretter må dette AksessToken sendes med i API-kallet: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken
Miljøer
Standard for hvordan URL’en til API’et vil se ut i alle miljøene: https://<BaseUrl>/verktoy/v1/verktoy
Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter
Terms and Conditions
Vilkår og betingelser for bruk av API'et: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser
Begrensninger
Systemet som forskriver verktøyet må på forhånd kjenne verktøyets unike GUID i Verktøykatalogen.
Testing
Oppsett av API-kliet i test-miljø(er) avtales som en del av kundeoppkoplingen
Versjonering og endringer
Dett er første versjon av API’et.