navikt / Helserefusjon-apne-data

API med åpne data for Helserefusjonsområdet
MIT License
0 stars 0 forks source link

= Helserefusjon - åpne data :toc: HTTP API med åpne data fra Helserefusjonsområdet. APIet leverer data på JSON og XML format.

== Om APIet Det tilbys API for følgende områder:

Lisens for offentlige data https://data.norge.no/nlod/no

Se også https://ehelse.no/takster

=== Ny rot-URL APIet var tidligere kun tilgjengelig på https://helserefusjoner-kuhr.nav.no. Denne vil på sikt bli faset ut. Ny rot URL er https://opne-data-api.helserefusjon.no. Det er også gjort en endring i pathene på URLene. De gamle URLene vil fortsette å fungere inntil ingen bruker de lenger.

== Takstkoder URL https://opne-data-api.helserefusjon.no/v1/takstkoder

=== Datainnhold

|=== | Felt | Beskrivelse

| takst_id | | takstkode | | fagomraade | | fradato | | tildato | | honorar | | refusjon | | egenandel | | pasient_egenbetaling | | maks_repetisjoner | | repetisjonsprosent | | redusert_ref_fra_repetisjon | | redusert_repetisjonsprosent | | spesialisttakst | | ugyldig_kombinasjon | | krever_takst | | krever_prosedyre | | krever_diagnose | | maks_antall_per_aar | | maks_antall_per_kalender_aar | | maks_antall_gjelder_pasient | | minimum_tidsbruk | | beskrivelse | | resource_id | | tidsbruk_per_rep | |===

=== Parametre

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | AP - Audiopedagog, BE - Behandlingsreiser i utlandet, FBV - Fritt behandlingsvalg, FY - Fysioterapi, HS - Helsestasjon, JO - Jordmor, KI - Kiropraktor, LE - Lege, LOGO - Logoped, LR - Privat lab/radiologi, OR - Ortoptist, PO - Poliklinikk, PS - Psykolog, PT - Primærhelseteam, RE - Rehabiliteringsinstitusjon, TH - Tannhelse, TP - Tannpleier | Query: gyldigdato | Filtrerer takstene til kun de som er gyldig på en gitt dato. Dato på formatet yyyy-MM-dd | Query: takstkode | Filtrer takstene til en gitt kode, kan kombineres med de andre parametrene eller brukes alene. | Query: beskrivelse | Filtrer på beskrivelsen til takstkoden, kan kombineres med de andre parametrene eller brukes alene. | Query: offisielle_ugyldige_takstkombinasjoner | Filtrer offisielle ugyldige takstkombinasjoner definert i feltet ugyldig_kombinasjon. Om alt filtreres så endres 'Alle unntatt' til 'Alle'. Mulige parametre: ja/nei. |=== For query på takstkode og beskrivelse kan %25 brukes for å angi wildcard søk. Feks. %25undersøkelse%25 for å søke på alt som inneholder undersøkelse.

==== Eksempel: https://opne-data-api.helserefusjon.no/v1/takstkoder?gyldigdato=2018-08-09&takstkode=2ad

== Labratoriekodeverk (NLK-koder) URL https://opne-data-api.helserefusjon.no/v1/nlkkoder

=== Datainnhold

|=== | Felt | Beskrivelse

| nlkKodeid | | nlkKode | | norsk_bruksnavn | | komponent | | system | | enhet | | egenskapsart | | spesifisertKomponent | | npuDefinisjon | | npuSpesialitet | | fagomraadeSekundaert | | fagomraadeNlk | | fradato | | tildato | | refusjonskategori | | erstattesAv | | hvaEndret | | sistEndretDato | | stjernekode | | ugyldigKombinasjon | | systemSpesifikasjon | | egenskapsartSpesifikasjon | | gruppering | | refusjonskategorisats | Liste av refusjonskategorier, se NLK refusjonskategorier for beskrivelse av feltene. |===

=== Parametre

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: gyldigdato | Filtrerer kodene til kun de som er gyldig på en gitt dato. Dato på formatet yyyy-MM-dd | Query: nlkkode | Filtrer til en gitt kode | Query: samhandlertype | PO - Poliklinikk, LR - Privat lab/radiologi |===

For query på nlkkode %25 brukes for å angi wildcard søk.

==== Eksempel: https://opne-data-api.helserefusjon.no/v1/nlkkoder?gyldigdato=2018-08-09&samhandlertype=PO

== Refusjonskategorier for NLK, NCRP og patologi URL https://opne-data-api.helserefusjon.no/v1/refusjonskategorisatser

=== Datainnhold

|=== | Felt | Beskrivelse

| refusjonskategoriid | | refusjonskategori | | refusjonssats | | fradato | | tildato | |===

=== Parametre

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: gyldigdato | Filtrerer kodene til kun de som er gyldig på en gitt dato. Dato på formatet yyyy-MM-dd | Query: samhandlertype | PO - Poliklinikk, LR - Privat lab/radiologi |===

==== Eksempel: https://opne-data-api.helserefusjon.no/v1/refusjonskategorisatser?gyldigdato=2018-08-09&samhandlertype=PO

== Apat kombinasjoner URL https://opne-data-api.helserefusjon.no/v1/apatkombinasjoner

=== Datainnhold

|=== | Felt | Beskrivelse

| t_kode | | p_kode | | refusjonskategori | | belop | | samhandler_type | | fradato | | tildato | | fradato | |===

=== Parametre

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: gyldigdato | Filtrerer kodene til kun de som er gyldig på en gitt dato. Dato på formatet yyyy-MM-dd | Query: samhandlertype | PO - Poliklinikk, LR - Privat lab/radiologi |===

== Aggregert takstbruk APIet tilbyr takstbruk statistikk for kommuner og fylker, fordelt på år, måned, fagområder og praksistyper. Den geografiske inndeling er basert på behandlers adresse. For kommuner/år er tallene begrenset til å bare ta med takster der antallet er større enn 5. For kommune/måned tallene er det begrenset til kommuner over 10 000 innbyggere.

Hvert API kan enten hente ut data som JSON eller XML eller som CSV. Det er forskjellige URLer avhengig av om det er JSON / XML eller CSV.

=== Datainnhold

|=== | Felt | Beskrivelse

| ar | | maned | | takstkode | | fagomraade | | praksis_type_kode | | behandler_kommunenr | | behandler_fylke | | antall_regninger | | sum_antall_takst | | sum_refusjon | | sum_egenandel_betalt_av_pasient | | sum_egenandel_dekket_av_folketrygden | |===

=== Kommune / Måned |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/kommune/maned | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/kommune/maned | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/kommune/maned | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: tommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: kommuner | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/kommune/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&kommuner=0301&praksistyper=FALE,LEVA

CSV:

https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/kommune/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&kommuner=0301&praksistyper=FALE,LEVA

=== Kommune / År |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/kommune/ar | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/kommune/ar | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/kommune/ar | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fomar | Obligatorisk | Query: tomar | Obligatorisk | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: kommuner | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/kommune/ar?fagomraade=LE&fomar=2015&tomar=2019&takstkoder=H1&kommuner=0301&praksistyper=FALE,LEVA

CSV: https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/kommune/ar?fagomraade=LE&fomar=2015&tomar=2019&takstkoder=H1&kommuner=0301&praksistyper=FALE,LEVA

=== Fylke / Måned |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/fylke/maned | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/fylke/maned | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/fylke/maned | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: tommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: fylker | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/fylke/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&fylker=03,15&praksistyper=FALE,LEVA

CSV: https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/fylke/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&fylker=03,15&praksistyper=FALE,LEVA

=== Fylke / År |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/fylke/ar | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/fylke/ar | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/fylke/ar | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fomar | Obligatorisk | Query: tomar | Obligatorisk | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: fylker | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/fylke/ar?fagomraade=LE&fomar=2015&tomar=2019&takstkoder=H1&fylker=03,15&praksistyper=FALE,LEVA

CSV: https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/fylke/ar?fagomraade=LE&fomar=2015&tomar=2019&takstkoder=H1&fylker=03,15&praksistyper=FALE,LEVA

=== Hele landet / måned |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/landet/maned | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/landet/maned | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/landet/maned | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: tommaned | Obligatorisk, lengden på perioden kan ikke være mer enn 13 måneder | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/landet/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&praksistyper=FALE,LEVA

CSV: https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/landet/maned?fagomraade=LE&fommaned=201805&tommaned=201905&takstkoder=H1&praksistyper=FALE,LEVA

=== Hele landet / år |=== |URL | Resultat format

| https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/landet/ar | JSON eller XML | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/agtakst/landet/ar | CSV | https://opne-data-api.helserefusjon.no/v1/takstbruk/eksport/msexcel/agtakst/landet/ar | Excel |===

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json | Query: fagomraade | Obligatorisk, komma separerte verdier. Se kodeverk for mulig verdier | Query: fomar | Obligatorisk | Query: tomar | Obligatorisk | Query: takstkoder | Komma separerte verdier. Se kodeverk for mulig verdier | Query: praksistyper | Komma separerte verdier. Se kodeverk for mulig verdier |===

===== Eksempel: JSON / XML:

https://opne-data-api.helserefusjon.no/v1/takstbruk/agtakst/landet/ar?fagomraade=LE&fomar=2015&tomar=2019&takstkoder=H11&praksistyper=FALE,LEVA

==== Eksempel: https://opne-data-api.helserefusjon.no/v1/apatkombinasjoner?samhandlertype=PO

== Kodeverk

=== Fylkesnummer https://data.norge.no/data/statens-kartverk/fylkesnummer

=== Kommunenr https://data.norge.no/data/kartverket/kommunenummer

=== Fagområder

https://opne-data-api.helserefusjon.no/v1/fagomraader

|=== | Kode | Beskrivelse

| AP | Audiopedagog | APO | Apotek | BE | Behandlingsreiser i utlandet | BI | Bidragsreiser | FBV | Fritt behandlingsvalg | FY | Fysioterapi | HS | Helsestasjon | JO | Jordmor | KI | Kiropraktor | KU | Kurssentra | LE | Lege | LOGO | Logoped | LR | Privat lab/radiologi | MU | Multidose | OP | Optiker | OR | Ortoptist | PO | Poliklinikk | PR | Pasientreiser | PS | Psykolog | PT | Primærhelseteam | RE | Rehabiliteringsinstitusjon | TH | Tannhelse | TP | Tannpleier |===

=== Praksistyper

|=== | Kode | Beskrivelse| Fagområde kode

| AUDI | Audiopedagog | AP | BEUT | Behandlingsreiser i utlandet | BE | BIRE | Bidragsreiser | BI | FRBE | Fritt behandlingsvalg | FBV | FAFY | Fastlønnstilskudd fysioterapi | FY | FYKO | Fysioterapeut kommunal | FY | FYMT | Manuellterapeut | FY | FYNO | Fysioterapeut | FY | FYPM | Psykomotoriker | FY | FYRT | Fysioterapeut rideterapi | FY | FYUM | Utdanningskandidat manuellterapi | FY | FYUP | Utdanningskandidat psykomotorikk | FY | FYUV | Utdanningskandidat fysio annet | FY | HELS | Helsestasjon | HS | JORD | Jordmor | JO | KINO | Kiropraktor | KI | KURS | Kurssentra | KU | FALE | Fastlege | LE | FALO | Fastlønnet | LE | FATU | LIS1-Lege | LE | LEKO | Legevakt kommunal | LE | LEVA | Legevakt | LE | SPAN | Spesialist anestesiologi | LE | SPBA | Spesialist barnesykdommer | LE | SPES | Spesialist | LE | SPFY | Spesialist fysikalsk medisin og rehabilitering | LE | SPGY | Spesialist gynekologi | LE | SPHU | Spesialist hudlege | LE | SPIN | Spesialist indremedisin | LE | SPKI | Spesialist kirurgi | LE | SPNE | Spesialist nevrologi | LE | SPOK | Spesialist onkologi | LE | SPOL | Spesialist øyelege | LE | SPON | Spesialist øre-nese-hals | LE | SPPS | Spesialist psykiatri | LE | SPRA | Spesialist radiologi | LE | SPRE | Spesialist revmatologi | LE | SYPL | Sykepleier | LE | URRE | H1-lege | LE | UTKA | Utdanningskandidat | LE | LOGO | Logoped | LOGO | LARO | Privat laboratorium og radiologi | LR | MULT | Multidose | MU | ORTO | Ortoptist | OR | SYKE | Poliklinikk | PO | PASI | Pasientreiser | PR | PSNE | Nevropsykolog | PS | PSNO | Psykolog | PS | PSUT | Utdanningskandidat psykoterapi | PS | OPPT | Rehabiliteringsinstitusjon | RE | TAFK | Fylkeskommunal kjeveortoped | TH | TAFY | Fylkeskommunal tannlege | TH | TAKJ | Tannlege kjeveortoped | TH | TANN | Tannlege | TH | TAPL | Tannpleier | TP | TAPO | Tannpleier offentlig | TP |===

== Bandasjister med direkte oppgjørsavtale URL https://opne-data-api.helserefusjon.no/v1/bandasjister

Henter ut siste gjeldende oversikt over bandasjister som er registrert med direkte oppgjørsavtale i Helfos Samhandlerregister (SAR).

=== Datainnhold

|=== | Felt | Beskrivelse

| sar_id |Unik id for samhandleren i SAR | sar_navn |Navn på bandasjist lagret i SAR | sar_orgnr |Orgnr. bandasjisten er lagret med i SAR og det er inngått avtale på | hovedenhet_orgnr |Bandasjistens hovedenhet hentet fra BRREG. Kan være det samme som sar_orgnr | underenhet_orgnr |Bandasjistens underenhet hentet fra BBREG. Kan være det samme som sar_orgnr. Vil ikke finnes hvis bandasjisten er registrert i SAR med hovedenhetens orgnr. | gyldig_fra |Fra og til dato for når bandasjisten er gyldig. Styres av avtale og praksis registrering gjort i SAR av Helfo. | gyldig_til | | status |Kan ha verdien "slettet" hvis bandasjisten ikke lenger er en aktiv enhet i BRREG. | tidspunkt_registrert |Når bandasjisten ble registrert i SAR | tidspunkt_oppdatert |Når bandasjisten sist ble oppdatert i SAR |===

=== Parametre

|=== | Parameter | Beskrivelse

| HTTP Header: Accept| Angir hvilket format data skal leveres på. Støtter application/xml og application/json |===