Table of Contents |
---|
Page Properties | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
API'ets formål
Dette kan benyttes når et eksternt system eller verktøy skal lagre dokumenter i innbyggers helsearkiv på Helsenorge. Dette kan være som informasjon til innbygger, eventuelt innbyggers kopi. Noen strukturerte dokumenter kan også inngå i arbeidsflyt på Helsenorge.
Fordeler med API'et
Eksterne systemer eller verktøy kan lagre dokumenter som er resultat av det innbygger “gjør”. Dette kan være som informasjon til innbygger eller fordi resultatet skal inngå i videre arbeidsflyt på Helsenorge.
Hvordan benytte API'et
Type API
REST POST
Requestbody
Tjenestenavn | Funksjon | Beskrivelse request | Eksempel | ||
---|---|---|---|---|---|
SaveDokument | Lagrer dokument med ett eller flere vedlegg, og eventuelt flere gjengivelser. Gjengivelser er samme innhold av hoveddokument, men i en annen form eller representasjon. Eks. Hoveddokument er PDF (som innbygger selv ser), men en gjengivelse kan være en XML-representasjon for det samme som eventuelt siden kan benyttes i andre systemer. | Hoveddokument:
Vedlegg (ett eller flere):
| Eksempel JSON:
|
Respons
Tjenestekallet returnere ved suksess en generert guid for det lagrede dokument.
Code Block |
---|
{ "DokumentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } |
Autentisering og autorisasjon
DokumentAPI’et kan kun benyttes når man har en innlogget innbygger og har fått et AksessToken via “sømløs pålogging” dvs. har benyttet Helsenorge som OpenID Connect provider. (03 - Innbygger innlogging - Helsenorge som OpenID Connect provider )
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
URL og Miljøer
Det skal benyttes HTTP POST med AksessToken fra Helsenorge OpenID Connect Provider.
<BaseUrl>/dokumenter/api/v1/SaveDokument
For oversikt over miljøer se 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
Det tilbys pr. i dag kun lagring av resultat fra Verktøy der det utføres egenkartlegging.
Testing
Oppsett av API-kliet klient i test-miljø(er) avtales som en del av kundeoppkoplingen
Versjonering og endringer
Dett er første versjon av API’et.