{BaseUrl}/verktoy/system/verktoy/v2

VerktoyId

guid

Verktøyets unike ID slik det er lagret i Verktøykatalogen

InnbyggerFnr

string

Innbyggers fødselsnummer (type string). Merk! det vil bli feilrespons dersom innbygger ikke er digitalt aktiv på Helsenorge.

AvsenderOrgNummer

string

Organisasjonsnummer til avsender av verktøyet.

AvsenderNavn

string

Navn på avsender slik den vil vises for innbygger på Helsenorge. Avsender står fritt til å angi aktuelt ‘nivå’, enten det er virksomhet, avdeling, klinikk eller en bestemt behandler.

FristDato

DateTime?

Valgfritt. Frist benyttes for å angi når oppgaven skal utføres. Hvis ikke frist angis settes den to uker frem i tid. Innbygger vil også ha mulighet til å utføre oppgaven i tre måneder etter at fristen har utløpt.

MERK! Helsenorge benytter kun angitte datoer i forretningslogikken. (Dvs. eventuell angivelse av time, minutt etc., tas ikke hensyn til)

Melding

string

Valgfritt. En tekstlig beskrivelse av oppgaven som vises til innbygger. Vises i tillegg til en standardtekst om at innbygger har mottatt en oppgave om å ta i bruk et verktøy i forbindelse med et behandlingsforløp. Maks. 1500 tegn.

JSON:

{
  "VerktoyId": "40b7e336-0a9b-48f6-bd5b-68c471e7971b",
  "InnbyggerFnr": "13766991003",
  "AvsenderOrgNummer": "999999999",
  "AvsenderNavn": "Helsedirektoratet",
  "FristDato": "2025-07-11",
  "Melding": "Spesifikk info om å ta i bruk verktøyet."
}

PseudoId er pasientens generete pseudo-id på helsenorge for den API-klienten som eier verktøyet.

{
  "PseudoId": null
}

• Lettvekts-API som er enkelt å implementere og ta i bruk. Mye av logikken og kompleksiteten er standardisert og håndteres av Helsenorge.

• Kan kun implementeres og brukes for å sende et bestemt verktøy (som regel fra behandlerdelen av verktøyet selv)

• Støtter retur av pseudo-ID for eldre integrasjonsformer

• Standardisert FHIR-API med mye fleksibilitet og valg knyttet til forretningslogikk og bruk som kan brukes til å sende ulike typer av oppgaver til innbyggere. Det å starte å bruke et verktøy er en spesifikk oppgavetype blant mange andre som også tilbys.

• Enkelt å ta i bruk hvis løsningen allerede sender ut oppgaver i andre sammenhenger, men høy brukerterskel ved førstegangs implementasjon. Dermed mest egnet for større aktører og systemer som har behov for å sende ut flere typer av oppgaver.

• Kan på sikt brukes av EPJer eller andre systemer for å velge blant et utvalg av verktøy som de skal kunne sende ut (som en erstatning for Verktøyformidleren)

• Har ikke støtte for retur av pseudo-ID

Dokumentasjon og mer informasjon: se denne siden

Dokumentasjon og mer info: Verktøystartoppgave

{BaseUrl}/verktoy/v1/Verktoy

VerktoyId

guid

Verktøyets unike ID slik det er lagret i Verktøykatalogen

InnbyggerFnr

string

Innbyggers fødselsnummer (type string). Merk! det vil bli feilrespons dersom innbygger ikke er digital aktiv på Helsenorge.

BehandlerHpr

string

Dette skal være behandlers HPR-nummer dersom dette er kjent i systemet som benytter API-et.

BehandlerFnr

string

Kan benyttes dersom behandlers HPR-nummer ikke er kjent i systemet som benytter API-et

FristDato

DateTime?

Valgfritt. Frist benyttes for å angi når oppgaven skal utføres. Hvis ikke frist angis settes den to uker frem i tid. Innbygger vil også ha mulighet til å utføre oppgaven i tre måneder etter at fristen har utløpt.

MERK! Helsenorge benytter kun angitte datoer i forretningslogikken. (Dvs. eventuell angivelse av time, minutt etc., tas ikke hensyn til)

Melding

string

Valgfritt. En tekstlig beskrivelse av oppgaven som vises til innbygger. Vises i tillegg til en standardtekst om at innbygger har mottatt en oppgave om å ta i bruk et verktøy. Maks. 1500 tegn.

JSON:

HPR-nummer kjent i system som benytter API, dato for frist og egen melding er angitt:

{
  "VerktoyId": "68ce99fd-6243-4ab0-b5bc-3ca81dbd53ba",
  "InnbyggerFnr": "0506634187",
  "BehandlerHpr": "123467",
  "FristDato": "2024-09-11",
  "Melding": "Spesifikk info om å ta i bruk verktøyet."
}

JSON:

Kun behandlers fødselsnummer er kjent i systemet som benytter API-et:

{
  "VerktoyId": "68ce99fd-6243-4ab0-b5bc-3ca81dbd53ba",
  "InnbyggerFnr": "0506634187",
  "BehandlerFnr": "12067231456"
}

PseudoId er pasientens generete PseudoId på helsenorge for den API-klient som utfører kallet.

{
  "PseudoId": ""
}

{BaseUrl}/verktoy/v1/SelvstendigVerktoy?Fagomrader=2&Malgrupper=2&Sprak=1&KanLeggesTilAvInnbygger=false&KunAnonymTilgang=true&Siderefereanse=1&AntallVerktoy=20

Fagomrader

list<enum>

Fagområde som verktøyet tilhører:

1. Psykisk helse

2. Fysisk helse

3. Livsstil

Klassifiseringer

list<string>

SNOMED CT-klassifisering for verktøyet.

Malgrupper

list<enum>

Verktøyets målgrupper:

1. Barn

2. Ungdom

3. Voksne

4. Eldre

Sprak

list<enum>

Hvilke språk som verktøyet støtter

1. Bokmål

2. Nynorsk

3. Engelsk

KanLeggesTilAvInnbygger

bool?

Om verktøyet er tilgjengelig for alle, eller om det kun er tilgjengelig hvis innbygger får det tilsendt fra en behandler.

KunAnonymTilgang

bool?

Om verktøyet er helt åpent (ikke krever innlogging) og er tilgjengelig for alle,
eller om det krever sentral brukerprofil og kun er tilgjengelig hvis innbygger får det tilsendt fra en behandler.

Sidereferanse

int

I forbindelse med paginering, hvilken side som skal returneres.

AntallVerktoy

int

Antall verktøy som returneres, maks antall er 50.

VerktoyId

guid

Verktøyets unike id

Navn

string

Verktøyets navn

Ingress

string

Innledende beskrivelse av verktøyet

Beskrivelse

string

Beskrivelse av verktøyet

OpprettetDato

DateTime

Når verktøyet ble opprettet

EndretDato

DateTime

Når verktøyet sist ble endret

VerktoyFormalTypeId

int

Enumverdi for verktøyets formål:

Verdier: 2, 4, 5

VerktoyFormalNavn

string

Navn på verktøyets formål

Verdier:

• Læring (VerktoyFormalTypeId: 2)

• Behandling (VerktoyFormalTypeId: 4)

• Kartlegging (VerktoyFormalTypeId: 5)

FagligAnsvarlig

string

Hvem som har det faglige ansvaret for verktøyet

UtvikletAv

string

Hvem som har utviklet verkøyet

SprakKode

string

Hvilke språk verktøyet støtter.

Verdier:

• "en-GB" (engelsk)

• "nn-NO" (nynorsk)

• "nb-NO" (bokmål)

SprakNavn

string

Språknavn:

Verdier:

• Engelsk

• Norsk Nynorsk

• Norsk Bokmål

FagomradeType

int

Fagområde verktøyet tilhører

Verdier: 1, 2, 3

FagomradeNavn

string

Navn på fagområde:

• Psykisk helse (FagomradeType: 1)

• Fysisk Helse (FagomradeType: 2)

• Livsstil (FagomradeType: 3)

LenkeType

enum

Type lenke tilknyttet verktøyet. Returnerer verdi 50 som er den eneste gyldige verdien i denne responsen.

LenkeTypeNavn

string

Lenketypens navn, returnerer: “Lenke til verktøy“

Url

Uri

Lenke til verkøyet

Sokeord

List<string>

Predefinerte søkeord som beskriver verktøyet

MalgruppeTypeId

int

Id for verkøyets målgrupper

Verdier: 1, 2, 3, 4

MalgruppeNavn

string

Målgruppenavn

Verdier:

• Barn (MalgruppeTypeId: 1)

• Ungdom (MalgruppeTypeId: 2)

• Voksne (MalgruppeTypeId: 3)

• Eldre (MalgruppeTypeId: 4)

GrafiskElementId

int

Id til verkøyets grafiske element

GrafiskElementTypeNavn

string

Type grafisk element

Verdier:

• Bilde

• Ikon

InnholdstypeId

int

Id for verktøyets innholdstype

Verdier: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

InnholdstypeNavn

string

Navn på innholdstype

Verdier:

• Video (InnholdstypeId: 1)

• Podcast (InnholdstypeId: 2)

• Informasjon (InnholdstypeId: 3)

• Oppgaver (InnholdstypeId: 4)

• Spill (InnholdstypeId: 5)

• Chat (InnholdstypeId: 6)

• Forum (InnholdstypeId: 7)

• Egenregistreringer (InnholdstypeId: 8)

• Måleverktøy (InnholdstypeId: 9)

• Anbefalinger og råd (InnholdstypeId: 10)

Behandlerinnsyn

string

Beskriver verktøyets behandlerinnsyn

Verdier:

• “Ingen”

• “Krever”

• “Tilbys i verktøyet”

KlassifiseringKode

string

Klassifiseringskode

KlassifiseringNavn

string

Klassifiseringnavn

KreverForskrivning

bool

Om verktøyet kun er synlig og tilgjengelig hvis behandler har sendt det til aktuell innbygger

Organisasjonsnummer

int

Organisasjonsnummer til verktøyets dataansvarlig

Organisasjonsnavn

string

Organisasjonsnavn til verktøyets dataansvarlig

AntattTid

int?

Antatt tid det tar å gjennomføre verktøyet (angitt i minutter).

{BaseUrl}/verktoy/v1/SelvstendigVerktoy/08ead360-0d65-448c-ba9e-8a08f0921c90

guid

Unik id for verktøy

VerktoyId

guid

Verktøyets unike id

Navn

string

Verktøyets navn

Ingress

string

Innledende beskrivelse av verktøyet

Beskrivelse

string

Beskrivelse av verktøyet

OpprettetDato

DateTime

Når verktøyet ble opprettet

EndretDato

DateTime

Når verktøyet sist ble endret

VerktoyFormalTypeId

int

Enumverdi for verktøyets formål:

Verdier: 2, 4, 5

VerktoyFormalNavn

string

Navn på verktøyets formål

Verdier:

• Læring (VerktoyFormalTypeId: 2)

• Behandling (VerktoyFormalTypeId: 4)

• Kartlegging (VerktoyFormalTypeId: 5)

FagligAnsvarlig

string

Hvem som har det faglige ansvaret for verktøyet

UtvikletAv

string

Hvem som har utviklet verkøyet

SprakKode

string

Hvilke språk verktøyet støtter.

Verdier:

• "en-GB" (engelsk)

• "nn-NO" (nynorsk)

• "nb-NO" (bokmål)

SprakNavn

string

Språknavn:

Verdier:

• Engelsk

• Norsk Nynorsk

• Norsk Bokmål

FagomradeType

int

Fagområde verktøyet tilhører

Verdier: 1, 2, 3

FagomradeNavn

string

Navn på fagområde:

• Psykisk helse (FagomradeType: 1)

• Fysisk Helse (FagomradeType: 2)

• Livsstil (FagomradeType: 3)

LenkeType

enum

Type lenke tilknyttet verktøyet. Returnerer verdi 50 som er den eneste gyldige verdien i denne responsen.

LenkeTypeNavn

string

Lenketypens navn, returnerer: “Lenke til verktøy“

Url

Uri

Lenke til verkøyet

Sokeord

List<string>

Predefinerte søkeord som beskriver verktøyet

MalgruppeTypeId

int

Id for verkøyets målgrupper

Verdier: 1, 2, 3, 4

MalgruppeNavn

string

Målgruppenavn

Verdier:

• Barn (MalgruppeTypeId: 1)

• Ungdom (MalgruppeTypeId: 2)

• Voksne (MalgruppeTypeId: 3)

• Eldre (MalgruppeTypeId: 4)

GrafiskElementId

int

Id til verkøyets grafiske element

GrafiskElementTypeNavn

string

Type grafisk element

Verdier:

• Bilde

• Ikon

InnholdstypeId

int

Id for verktøyets innholdstype

Verdier: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

InnholdstypeNavn

string

Navn på innholdstype

Verdier:

• Video (InnholdstypeId: 1)

• Podcast (InnholdstypeId: 2)

• Informasjon (InnholdstypeId: 3)

• Oppgaver (InnholdstypeId: 4)

• Spill (InnholdstypeId: 5)

• Chat (InnholdstypeId: 6)

• Forum (InnholdstypeId: 7)

• Egenregistreringer (InnholdstypeId: 8)

• Måleverktøy (InnholdstypeId: 9)

• Anbefalinger og råd (InnholdstypeId: 10)

Behandlerinnsyn

string

Beskriver verktøyets behandlerinnsyn

Verdier:

• “Ingen”

• “Krever”

• “Tilbys i verktøyet”

KlassifiseringKode

string

Klassifiseringskode

KlassifiseringNavn

string

Klassifiseringnavn

KreverForskrivning

bool

Om verktøyet kun er synlig og tilgjengelig hvis behandler har sendt det til aktuell innbygger

Organisasjonsnummer

int

Organisasjonsnummer til verktøyets dataansvarlig

Organisasjonsnavn

string

Organisasjonsnavn til verktøyets dataansvarlig

AntattTid

int?

Antatt tid det tar å gjennomføre verktøyet (angitt i minutter).

{BaseUrl}/verktoy/v1/SelvstendigVerktoy/SokSelvstendigVerktoy?SokeOrd=test&RowCount=10

SokeOrd

string

Søket søker etter ord som begynner med søkeordet og som må være mellom 3-256 karakterer lang.

RowCount

int

Antall verktøy som ønskes returnert i response. By default returneres det inntil 50 verktøy som er maks antall. Dette kan nedjusteres med denne parameteren.

VerktoyId

guid

Verktøyets unike id

Navn

string

Verktøyets navn

{BaseUrl}/verktoy/v1/GrafiskElement/5

int

Id til grafisk element

{BaseUrl}/verktoy/v1/Veiledningstjeneste/3fa85f64-5717-4562-b3fc-2c963f66afa6

Request Body:

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Telefon": "string",
  "Url": "string",
  "Apningstider": [
    {
      "Dag": 1,
      "FraKl": "string",
      "TilKl": "string",
      "ApenHeleDagen": true
    }
  ]
}

Id

guid

Id til veiledningstjeneste hentes fra siste ledd i URL til tjenesten. Id i request body ignoreres.

Telefon

string

Veiledningstjeneste telefonnummer

Url

string

Url til veiledningstjenesten

Apningstider

List<enum>

Liste med åpningstider for veiledningstjenesten

• Dag - enumverdier mandag-søndag

• FraKl - TimeSpan?, åpent fra klokkeslett

• TilKl -TimeSpan?, åpent til klokkeslett

• ApenHeleDagen - bool?, åpent hele dagen

VerktoyId

guid

Verktøyets unike id

Id

string

Id til behandler som har sendt verktøyet til innbyggeren. Enten HPR-nummer eller fødselsnummer

IdType

string

Type id for id til behandler som har sendt verktøyet til innbyggeren

Verdier:

• HPR: HPR-nummer

• FNR: Fødselsnummer

Navn

string

Fullt navn til behandler som har sendt verktøyet til innbyggeren

VER-000202

400

Request er null

VER-000205

400

Søkeord er en tom streng eller null

VER-000254

400

Søkeordet er enten for kort eller for lang (må være mellom 3-256 tegn).

VK-001126

404

Fant ingen verktøy med angitt id

VK-001206

400

Ugyldig sidestørrelse ved uthenting av verktøyliste

VER-000209

400

Ugyldig verdi for id

VER-000204

400

Verdi for enum er ikke definert

PVF-000239

400

Finner ikke helsepersonellinformasjon for angitt HPR-nummer

VER-000218

400

Verktøy allerede sendt til innbygger av samme behandler

VER-000232

400

Verktøy allerede sendt

VER-000228

400

Innbygger er ikke digitalt aktiv på helsenorge

VER-000207

400

Finner ikke verktøy med angitt verktøy id

PVS-000204

500

Feil ved underliggende tjeneste

VER-000260

400

Verktøyet er ikke sendt fra en behandler

VER-000261

400

Finner ikke kobling mellom verktøy og innbygger