Fravaersregistrering
- 1 Metodens formål
- 2 Detaljert dokumentasjon av metoden
- 2.1 Autentisering og autorisering
- 2.2 HTTP-verb
- 2.3 Request
- 2.3.1 GetTidsperioder
- 2.3.2 SaveTidsperiode
- 2.3.3 DeleteTidsperiode
- 2.3.3.1 Request
- 2.4 Swagger
- 2.5 Miljøer
- 3 Feilmeldinger
API-navn | Fravaersregistrering |
---|---|
Metode/funksjon | Tidsperiode |
Endepunkt | https://{BaseUrl)/helsetilbud_externalapi/api/v1/Tidsperiode |
Funksjonelt område |
|
API-versjon og dato publisert |
|
Status | utvikling |
API-dokumentasjon og sist endret | Jun 3, 2024 |
Teknologi | REST |
Metodens formål
Metoden kan brukes av eksterne aktører for å registrere, se og slette fraværsperioder for fastlegetjenester. Fraværet registreres på tjenestenivå og innslagene inneholder tjeneste-id, fraogmed/tilogmed-dato og liste over tjenester.
Detaljert dokumentasjon av metoden
Autentisering og autorisering
HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes
Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
Velg deretter scope “fravaersregistrering”
Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId, dette kan så benyttes i tjenestekallet mot API’et
HTTP-verb
Alltid anvend https og HTTP-verbet som metode krever (GET, POST, DELETE). AksessToken fra HelseId STS skal være med i Authorization header i alle kall. Se her: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken
Request
GetTidsperioder
Request
Plassering | Navn | Type | Beskrivelse |
---|---|---|---|
Header | Authorization: bearer {access-token} |
| Aksess token fra HelseId sikkerhetstjeneste, etter å ha autentisert/autorisert seg mot denne. |
URL | HerId | int | HerId til tjenesten (fastlegen) eller virksomheten, som må tilhøre organisasjonen som utfører kallet. Returnerer lagrede fravær-innslag for tjenesten eller virksomheten. |
KunAktive | bool | Hvis ja så ekskluderes følgende fra responsen: tidsperioder der tidperioden fraogmed/tilogmed ikke inneholder dagens dato. |
Respone
{
"tidsperioder": [
{
"id": 4,
"type": "Fravaer",
"organisasjonsnummer": "999944454",
"herId1": 8091456,
"herId2": 8093236,
"fraOgMedDato": "2024-06-01",
"tilOgMedDato": "2024-06-05",
"tjenestetyper": [
"ekontakt"
]
},
{
"id": 6,
"type": "Fravaer",
"organisasjonsnummer": "999944454",
"herId1": 8091456,
"herId2": 8093236,
"fraOgMedDato": "2024-06-20",
"tilOgMedDato": "2024-06-14",
"tjenestetyper": [
"timebestilling", "reseptfornyelse"
]
},
{
"id": 7,
"type": "Fravaer",
"organisasjonsnummer": "999944454",
"herId1": 8091456,
"herId2": 8093236,
"fraOgMedDato": "2024-08-15",
"tilOgMedDato": "2024-11-14",
"tjenestetyper": [
"ekonsultasjon"
]
}
]
}
SaveTidsperiode
Request
Plassering | Navn |
| Type | Beskrivelse |
---|---|---|---|---|
Header | Authorization: bearer {access-token} |
| Aksess token fra HelseId sikkerhetstjeneste, etter å ha autentisert/autorisert seg mot denne. | |
Content-Type | application/json | JSON-format | ||
Body | Oppsett | Type | enum | Type tidsperiode som skal registreres. Per nå støtes kun fravaer |
HerId | int | HerId til tjenesten (fastlegen). Tjenesten må tilhøre organisasjonen som utfører kallet. | ||
FraOgMedDato | date | Datoen på formatet YYYY-mm-dd, angir dagen som fraværsperioden starter (fraværet inkluderer denne datoen) | ||
TilOgMedDato | date | Datoen på formatet YYYY-mm-dd, angir dagen som fraværsperioden slutter (fraværet inkluderer denne datoen) | ||
Tjenestetyper | enum | Hvilke tjeneste(r) som fraværet skal registreres for. |
Response
{
"lagretTidsperiode": {
"id": 123,
"type": "Fravaer",
"organisasjonsnummer": "12345678910",
"herId1": 8044455,
"herId2": 8044499,
"fraOgMedDato": "2024-05-15",
"tilOgMedDato": "2024-05-15",
"tjenestetyper": [
"ekontakt"
]
}
}
DeleteTidsperiode
Request
Plassering | Navn | Type | Beskrivelse |
---|---|---|---|
Header | Authorization: bearer {access-token} |
| Aksess token fra HelseId sikkerhetstjeneste, etter å ha autentisert/autorisert seg mot denne. |
Content-Type | application/json | JSON-format | |
URL/Body | Id | int | Identifikatoren til innslaget som skal slettes. Denne settes/returneres ved opprettelse (SaveTidsperiode) og kan også leses fra uthenting av tidsperioder (GetTidsperioder). |
| HerId | int | HerId til tjenesten (fastlegen). Tjenesten må tilhøre organisasjonen som utfører kallet. |
Swagger
Miljøer
URL for å nå endepunktet (forskjellig pr miljø): https://<miljø>/fravaersregistrering/v1
Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter
Feilmeldinger
Følgende responskoder kan forventes fra Helsenorge:
Kode | Beskrivelse |
---|---|
200 | Alt OK |
400 | Validering av request feiler |
401 | Autorisasjon er feil eller mangler |
403 | Tilganger mangler |
500 | Midlertidig feil, prøv igjen senere |
Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.
Eksempler:
{ "Code": "HT-102021", "Message": "MissingAuthenticationHeader : Fault code: HT-102021",}
{ "Code": "HT-000118", "Message": "HerId 1234567 er ikke gyldig : Fault code: HT-000118",}
{ "Code": "HT-000117", "Message": "Tidsperiode med id 1234 finnes ikke : Fault code: HT-000117"}
{ "Code": "HT-000115", "Message": "Feil dato i request : Fault code: HT-000115"}"}