Helseindikator-API
- Kjernejournal systembruker
API-navn | Helseindikator |
|---|---|
API-versjon og dato publisert | v1 Mar 10, 2021 |
Status | I Drift |
Teknologi | REST |
API'ets formål
Helseindikator API returnerer pasientens status i kjernejournal. Den returnerer også en billett fra kjernejournal som representerer både helsepersonellets virksomhet og pasienten. Med grunnlag for åpning lagret i billetten kan kjernejournal bruke samme grunnlag for påfølgende åpning av KJ-portalen. Hvis grunnlaget er oppgitt, kan brukeren bli tatt opp direkte i portalen uten å ta stilling til samtykkeplakaten.
EPJ-systemet bør validere fnr / dnr etter regler for gyldige fødselsnummer før det sendes til kjernejournal.
Helseindikator APIet brukes også for å hente en ticket som kreves ved bruk av andre tjenester (eksempelvis Fastlege-API)
Fordeler med API'et
Statusresponsen brukes til å presentere kjernejournal ikonet i et klinisk fagsystem i tråd med informasjonen som er registrert i kjernejournal. Ikonet skal være klikkbart og dermed også benyttes for å åpne selve kjernejournal.
Hvordan benytte API'et
Type API
REST
Metoder og parametre til endepunktet
Input parameter:
Parameter | Request eksempel | Beskrivelse |
|---|---|---|
fnr |
| Pasientens identifikator (fødsels- eller D-nummer). EPJ-systemet må validere fnr / dnr før det sendes til kjernejournal etter regler for gyldige fødselsnummer. |
samtykke | HPMOTTATTSAMTYKKE | Grunnlag for åpning av kjernejournal (samtykke, nødsituasjon eller unntak fra samtykke) kan inkluderes i API kallet. Grunnlaget skal lagres i ticket tilhørende sesjonen som opprettes ved å kalle helseindikatoren, slik at den kan brukes ved senere API kall. Med grunnlag for åpning lagret i ticket kan samme grunnlag benyttes for påfølgende åpning av KJ-portalen. |
Se swagger for mer informasjon.
POST
Request eksempel
POST /v1/helseindikator/ HTTP/1.1
Host: api.kjernejournal.no:8000
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkE4...u_UjgeTxzxI2g
X-EPJ-system: ACME EHR system versjon 42.01
{"fnr":"13116900216","samtykke":"HPMOTTATTSAMTYKKE"}Merk. Request skal, i HTTP header, inkludere "X-EPJ-system" som informerer om hvilket EPJ system og hvilken versjon det er som utfører kallet.
Respons eksempel
HTTP/1.1 200 OK
Cache-Control: no-cache, must-revalidate, private, s-maxage=0
Pragma: no-cache
Content-Type: application/json; charset=utf-8
{
"returTekst": "OBS: Kritisk informasjon i kjernejournal",
"sistEndretKritiskInfoDato": "2017-11-29T16:35:19.003Z",
"status": 4,
"ticket": "ca2gveFcW%2BdZqO2Fx7EG773Lh0TUvO2gtz45gQCccErKpXBJf8yS3ROacFn%2Bq"
}
Swagger
https://api.st2.kjernejournal-test.no:8000/v1/helseindikator/swagger-ui.html
Autorisering
Se Integration Guide: Kjernejournal REST API using HelseID as authenticator (kun på engelsk).
Autentisering
Se Integration Guide: Kjernejournal REST API using HelseID as authenticator (kun på engelsk).
Versjonering og endringer
Versjonering synliggjøres i APIet URL: / v1 /
Kjernejournal har planer om å støtte minst 2-3 versjoner av et API. Detaljer om deres utgivelsesplan, støtte og dokumentasjon vil bli publisert senere.
Dokumentasjon av tidligere versjoner
Kun en versjon av APIet tilgjengelig.
Integrasjonsguide
Se integrasjonsguide for Rest API for detaljer, inkluderer informasjon om feilmeldinger:
Integration Guide: Kjernejournal REST API using HelseID as authenticator (kun på engelsk).
© Norsk helsenett - kjernejournal