1 API'ets formål
- 1.1 Fordeler med API'et
2 Hvordan benytte API'et
- 2.1 Type API
- 2.2 Requestbody
  - 2.2.1 Respons
- 2.3 Autentisering og autorisasjon
- 2.4 URL og Miljøer
- 2.5 Terms and Conditions
- 2.6 Begrensninger
- 2.7 Testing
3 Versjonering og endringer

API-navn	DokumentAPI
Funksjonelt område	Pr. nå beskrevet sammen med Verktøy: Teknisk integrasjon mellom digitale verktøy og Helsenorge
API-versjon og dato publisert	Siste versjon av API'et Oct 10, 2021
Status	I Drift
API-dokumentasjon sist endret	Jan 17, 2022
Teknologi	REST

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”.

Hvordan benytte API'et

Type API

REST POST

Requestbody

Tjenestenavn	Funksjon	Beskrivelse request	Eksempel

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:

Innhold: “base64 encoded”
Eventuelle vedlegg: (se under)
Konteksttype: Angir om innholdet skal inngå i en workflow på Helsenorge eller ikke. Foreløpig er kun en slik workflow definert:
- Fastlegetjenester = 6
- Ekstern = 7 (Ingen workflow på Helsenorge)
Innholdstype: Kategoriserer dokumentet (i oversikter for innbygger). Foreløpig er kun en innholdstype definert for eksterne systemer som skal lagre dokumenter i innbyggers Helsearkiv:
- Egenkartlegging = 6
scope: Dette benyttes for å kategorisere innen hvilket område på Helsenorge dokumentet hører til. Dette er samme kodeverk som benyttes for eksempel i DigitalAktiv sjekk på Helsenorge.
- OmradeHelseregister = 1
- OmradePasientjournal = 2
- OmradeHelsehjelp = 3
- OmradeHelseforvaltning = 4
- OmradeSekundærbruk = 5
- OmradeUngdom = 6 (Dette er en egen kategorisering av tjenester som er for ungdom i alder 13-16 år, og der foreldre ikke har innsyn).
externalReferenceID: Det er en frivillig verdi som verktøyet kan sette for å angi en egen refereranse for dokumentet. Flere dokumenter kan ha samme ekstern referanse.
mimeType: Dokumentest mime-type. Normalt et “lesbart format for innbygger”.
- application/pdf
dokumentNavn: Dokumentets navn slik det vises for innbygger.

Vedlegg (ett eller flere):

VedleggInnhold: Base64 encoded
MimeType: Vedleggets mimetype. Kan være lesbart format eller strukturert format:
- application/pdf
- application/octet-stream (binært vedlegg)
- application/xml
dokumentNavn: Vedleggets navn

Eksempel JSON:

{
  "filBase64Encoded": "string",
  "vedlegg": [
    {
      "filBase64Encoded": "string",
      "mimeType": "string",
      "dokumentNavn": "string"
    }
  ],
  "kontekstType": 7,
  "innholdType": 6,
  "scope": 1,
  "externalReferenceId": "string",
  "mimeType": "string",
  "dokumentNavn": "string"
}

Respons

Tjenestekallet returnere ved suksess en generert guid for det lagrede dokument.

{
  "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: 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-klient i test-miljø(er) avtales som en del av kundeoppkoplingen

Versjonering og endringer

Dett er første versjon av API’et.

DokumentAPI