SmartRegister API
- 1 API-ets formål
- 2 Hvordan benytte API-et
- 3 Feilmeldinger
- 4 Versjonering og endringer
API-navn | SmartRegister API |
|---|---|
Funksjonelt område | |
API-versjon og dato publisert | v1 Oct 27, 2020 |
Status | I Drift |
API-dokumentasjon sist endret | Jan 26, 2023 |
Teknologi | REST |
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
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
Request eksempel |
|---|
/smartregister/v1/Applikasjoner |
Response
Parameternavn | Type | Beskrivelse | |
|---|---|---|---|
applikasjoner | liste | Liste over over alle tredjeparts applikasjoner i registeret | |
| navn | string | Navn på applikasjonen |
| versjon | string | Versjon av applikasjonen |
| guid | guid | Unik id til applikasjonen i smart-registeret |
httpStatusCode | int | Fast verdi: 200. Bekrefter at funksjonen kunne utføres | |
Response eksempel |
|---|
{
"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
Request eksempel |
|---|
/smartregister/v1/HelsepersonellTilknytning?HprId=1234567&ApplikasjonGuid=e5762e44-6830-42a3-9e83-c76203d02871 |
Parameternavn | Type | Beskrivelse |
|---|---|---|
HprId | int | HPR-nummer til helsepersonellet |
ApplikasjonGuid | guid | Unik id til applikasjonen i smart-registeret |
Response
Response eksempel |
|---|
{
"httpStatusCode": 200
} |
DELETE HelsepersonellTilknytning
Beskrivelse: Fjerner et helsepersonell som bruker av en applikasjon.
Request
Request eksempel |
|---|
/smartregister/v1/HelsepersonellTilknytning?HprId=1234567&ApplikasjonGuid=e5762e44-6830-42a3-9e83-c76203d02871 |
Parameternavn | Type | Beskrivelse |
|---|---|---|
HprId | int | HPR-nummer til helsepersonellet |
ApplikasjonGuid | guid | Unik id til applikasjonen i smart-registeret |
Response
Response eksempel |
|---|
{
"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:
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
Feilkode | HTTP statuskode | Beskrivelse |
|---|---|---|
SRE-000000 | 500 | Generell teknisk feil |
SRE-010001 | 400 | Request kan ikke være null |
SRE-010003 | 400 | HPR-nummer kan ikke være null |
SRE-010004 | 400 | Applikasjon guid ikke angitt |
SRE-010005 | 400 | Applikasjon ikke funnet |
SRE-010006 | 400 | HPR-nummer ikke funnet |
SRE-010007 | 400 | Ugyldig HPR-nummer |
SRE-010008 | 400 | Finner ikke tilknytning mellom applikasjon og HPR-nummer |
SRE-010009 | 400 | Tilknytning mellom applikasjon og HPR-nummer finnes allerede |
SEC-110000 | 401 | Token is expired or invalid |
Versjonering og endringer
Dette er første versjon av API-et.