API-ets formål

API-et gjør det mulig for eksterne aktører å legge til og fjerne helsepersonell som brukere av tredjeparts applikasjoner. Slik at pasienter med en relasjon til disse helsepersonellene kan få tilpasset funksjonalitet på Helsenorge.

Pasienter som har en fastlege som er registrert som bruker av Førerrett app får mulighet til å dele visse typer dokumenter/egenerklæringer med fastlegen via Helsenorge

Hvordan benytte API-et

Autorisasjon

HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes:

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

   1. Velg deretter scope “Smartregister”

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

Se ytterligere detaljer her: 01 - System til System

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

Type API

REST

Metoder og parametre til endepunktet

GET Applikasjoner

Beskrivelse: Henter en liste over alle tredjeparts applikasjoner der funksjonalitet på Helsenorge har tilpasninger basert på om helsepersonell er tilknyttet disse.

Request

Response

{
  "applikasjoner": [
    {
      "navn": "Førerrett App",
      "versjon": "1.0.0",
      "guid": "e5762e44-6830-42a3-9e83-c76203d02871"
    }
  ],
  "httpStatusCode": 200
}

POST HelsepersonellTilknytning

Beskrivelse: Legger til et helsepersonell som bruker av en applikasjon.

Request

Response

{
  "httpStatusCode": 200
}

DELETE HelsepersonellTilknytning

Beskrivelse: Fjerner et helsepersonell som bruker av en applikasjon.

Request

Response

{
  "httpStatusCode": 200
}

Swagger

Swagger - SmartRegister External API

Autentisering og autorisasjon

Alle API-er krever at klienten på forhånd har autentisert seg mot vår Sikkerhetstjeneste og fått utstedt et aksesstoken som skal være med i tjenestekallene til det enkelte API.
For mer informasjon se Hvordan få tilgang til API'er på Helsenorge og PVK

SmartRegister API støtter kun System til System-autorisasjon.

Miljøer

Standard for hvordan URL’en til API’et vil se ut i alle miljøene: https://<BaseUrl>​/smartregister/v1​/

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

Ingen

Testing

Oppsett av API-klient i test-miljø avtales som en del av kundeoppkoplingen.

Feilmeldinger

Beskriv her hvilke feilmeldinger brukeren kan få og hva de betyr

Versjonering og endringer

Dette er første versjon av API-et.