Helsepersonellregisteret Offentlig API
APIet tilgjengeliggjør åpne data fra Helsepersonellregisteret (HPR) over internett til norske virksomheter og er sikret med Maskinporten. Dette APIet er kun ment for virksomheter utenfor Helsenettet.
Tilgjengelige miljø
| Miljø | URL | API-dokumentasjon |
|---|---|---|
| Test | https://api.offentlig.test.hpr.nhn.no/ | OpenAPI |
| Produksjon | https://api.offentlig.hpr.nhn.no/ | Finnes ikke |
Tilgang
Som konsument trenger du en token fra Maskinporten. For mer informasjon om å få denne token, se Maskinporten-dokumentasjonen.
| Type tilgang | Scope | Forklaring | Må godkjennes av Helsedirektoratet? | Hvordan skaffe tilgang? |
|---|---|---|---|---|
| Basis | nhn:hpr/basic | Åpne data som fritt kan brukes. | Nei | Gi klienten scopet nhn:hpr/basic via Maskinportens Selvbetjeningsportal NB: Pass på å filtrere etter scopes som er "Tilgjengelig for alle". |
| Utvidet | nhn:hpr/extended | Åpne data samt norsk identitetsnummer (fødselsnummer eller d-nummer) for helsepersonellet. | Ja | Etterspør tilgang til scopet via godkjenning@helsedir.no |
| Eksport | nhn:hpr/export | Inneholder samme data som utvidet og gir konsumenten tilgang til hele datasettet. | Ja | Etterspør tilgang til scopet via godkjenning@helsedir.no |
** Vær oppmerksom på at selv om din virksomhet er tildelt et scope, må det fortsatt manuelt legges til dine klientkonfigurasjoner.
Endepunkter
| HTTP | Endepunkt | Forklaring | Hvilken tilgang kreves? |
|---|---|---|---|
| GET | /v1/personer/ | Hent en person med HPR-nummer | Basis |
| GET | /v1/personer | Søk etter person med etternavn og fødselsdato | Basis |
| GET | /v1/personerutvidet/ | Hent en person med HPR-nummer | Utvidet |
| GET | /v1/personerutvidet | Søk etter person med etternavn og fødselsdato | Utvidet |
| POST | /v1/personerutvidet | Hent en person med fødselsnummer | Utvidet |
| GET | /v1/export | Hent ut all HPR data som zippet JSON-fil | Eksport |
FAQ
Hvordan får jeg logget på maskinportens selvbetjeningsportal med en virksomhet?
Du må være er knyttet til et virksomhet gjennom Altinn for å få tilgang til maskinportens selvbetjeningsportal. En administrator for din virksomhet kan delegere dette til deg via https://info.altinn.no/. For mer informasjon om dette oppsettet se Altinn sin dokumentasjon. Rollene som skal tildeles der er Selvbetjening av integrasjoner i ID-porten/Maskinporten.
Jeg finner ikke scopet nhn:hpr/basic
Pass på å filtrere scopes etter scopes som er "Tilgjengelig for alle".
Jeg har blitt gitt tilgang til det utvidete scopet, men jeg får ikke laget tokens med dette scopet
Selv om din virksomhet tildeles det utvidete scopet, må det fortsatt manuelt legges til dine klientkonfigurasjoner.
Hvordan fungerer rate limiting?
Vi bruker token bucket rate limiting. Med en bøttestørrelse på 200 og en periodisk refill på 10/minutt. Det vil si at din bruker har en "bøtte" som kan holde 200 kall, men som bare fylles opp igjen med 10/minutt. Dermed kan du gjøre 200 kall om du ikke har brukt API-et på en stund, men når "bøtta er tom" så kan du bare gjøre 10 kall per minutt.