Helsepersonellregisteret Offentlig API
Helsepersonellregisteret Offentlig API gjør offentlige data fra Helsepersonellregisteret (HPR) offentlig tilgjengelig og sikret med Maskinporten.
APIet er tilgjengelig på https://api.offentlig.hpr.nhn.no. Merk at vår Swagger-dokumentasjon ikke er deployet i produksjon, så du vil se en tom side når du besøker denne siden.
Vår Swagger-dokumentasjon finnes på vårt testmiljø: https://api.offentlig.test.hpr.nhn.no/swagger/index.html.
Miljø
| Miljø | URL |
|---|---|
| Test | https://api.offentlig.test.hpr.nhn.no/ |
| Prod | https://api.offentlig.hpr.nhn.no/ |
Brukertilgang og autorisering
For å få bruker-tilgang vil du trenge en token fra Maskinporten. For mer informasjon om å få denne token, se Maskinporten-dokumentasjonen(https://docs.digdir.no/docs/Maskinporten/maskinporten_overordnet.html).
Scopes
Vi tilbyr forskjellige scopes som gir brukeren tilgang til forskjellige endepunkter på APIet. Basis-scopet (nhn:hpr/basic) inneholder åpne data og er tilgjengelig for alle med et norsk organisasjonsnummer.
For å få tilgang til basis-scopet, kan du gi deg selv tillatelse til nhn:hpr/basic via Maskinportens Selvbetjeningsportal (Pass på å filtrere scopes etter scopes som er "Tilgjengelig for alle").
De andre scopene vi tilbyr inneholder ekstra data som krever autorisasjon fra Helsedirektoratet for å få tilgang. Om du ønsker tilgang til dette, kan det etterspørres via godkjenning@helsedir.no. Vær oppmerksom på at selv om din organisasjon tildelt et scope, må det fortsatt manuelt legges til dine klientkonfigurasjoner.
| Scope | Forklaring |
|---|---|
| nhn:hpr/basic | Basis-scope, inneholder åpne data og kan fritt brukes uten at det har blitt godkjent. |
| nhn:hpr/extended | Utvidet-scope, inneholder åpne data med noe ekstra persondata og kan kun brukes om det har blitt godkjent av Helsedirektoratet. |
| nhn:hpr/export | Export-scope, inneholder samme data som utvidet scope men gir brukeren tilgang til å laste ned hele datasettet. Kan kun brukes om det har blitt godkjent av Helsedirektoratet. |
Endepunkter
Offentlige Endepunkter (nhn:hpr/basic)
| HTTP | Endepunkt | Forklaring |
|---|---|---|
| GET | /v1/personer/ | Hent en person med HPR-nummer |
| GET | /v1/personer | Søk etter person med etternavn og fødselsdato |
Utvidete Endepunkter (nhn:hpr/extended)
| HTTP | Endepunkt | Forklaring |
|---|---|---|
| GET | /v1/personerutvidet/ | Hent en person med HPR-nummer, |
| GET | /v1/personerutvidet | Søk etter person med etternavn og fødselsdato |
| POST | /v1/personerutvidet | Hent en person med fødselsnummer |
Export Endepunkter (nhn:hpr/export)
| HTTP | Endepunkt | Forklaring |
|---|---|---|
| GET | /v1/export | Hent ut all HPR data som zippet JSON-fil |
FAQs
Hvordan får jeg logget på maskinportens selvbetjeningsportal med Organisasjonsnummer? Du må være er knyttet til et organisasjonsnummer gjennom Altinn for å få tilgang til maskinportens selvbetjeningsportal. En administrator for din organisasjon kan delegere dette til deg via https://info.altinn.no/. For mer informasjon om dette oppsettet se Altinn sin dokumentasjon https://info.altinn.no/hjelp/profil/enkelttjenester-og-roller/hvordan-gi-en-enkelttjeneste-og-rolle-til-andre/, rollene som skal tildeles der er Selvbetjening av integrasjoner i ID-porten/Maskinporten.
Jeg finner ikke det åpne scopet nhn:hpr/basic-scope Pass på å filtrere scopes etter scopes som er "Tilgjengelig for alle".
Jeg har blitt gitt tilgang til det utvidet scopet, men jeg får ikke laget tokens med dette scopet Selv om din organisasjon 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.