API- Opprette ny Part
API-navn | Personverninnstilling- Opprette ny Part |
|---|---|
Funksjonelt område | |
API-versjon og dato publisert | V1 May 19, 2026 |
Status | I DRIFT |
API-dokumentasjon sist endret | Apr 15, 2026 |
Teknologi | REST |
API'ets formål
API`et gir eksterne aktører mulighet til å opprette en ny Part koblet til sin Aktør. Den nye parten kan igjen brukes ved opprettelse av nye personverninnstilling definisjoner basert på en eksisterende mal API- Opprette personverninnstillingsdefinisjon. Den nye parten identifiserers av en unik part kode og kobles til aktøren som er registrert for API klienten som oppretter parten.
Tjenesteoversikt
Navn | Http verb | Beskrivelse |
|---|---|---|
Opprett part | POST <system url>/personvern/part/v1 | Oppretter en ny part |
Oppdater part | PUT <system url>/personvern/part/v1 | Oppdaterer en eksisterende part |
Autorisasjon og aksesstoken
HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes:
Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
Velg deretter scope “Personverndefinisjon_skriv”
Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId
Se ytterligere detaljer her: 3. Ekstern applikasjon kaller Helsenorge API i systemkontekst
3. Ekstern applikasjon kaller Helsenorge API i systemkontekst
AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene.
Opprett part
Request parametere
Navn | Type | Påkrevd / Frivillig | Lovlige verdier | Kommentar |
|---|---|---|---|---|
partKode | string | Påkrevd | En ny unik partkode | Part koder defineres med små bokstaver uten æ, ø, å eller andre spesialtegn. Mellomrom ersattes med bindestrek (-). Ved behov for flere partkoder anbefales det at de grupperes sammen med en felles identifikator som prefix før den unike delen av partkoden. For eksempel: kj-innstillinger NB: Eventuelle mellomrom i starten/slutten av partKoden vil strippes vekk og øvrige mellomrom i koden vil erstattes med bindestrek ved lagring. |
navn | string | Påkrevd | Navn på register/ forskningsprosjekt/ studie/ biobank | Det offisielle navnet på parten, dette vil vises til innbygger på Helsenorge. |
kortNavn | string | Frivillig | Ett kortnavn som benyttes om register/ forskningsprosjekt/ studie/ biobank | Hvis angitt sammen med en uri vil kortNavn benyttes til å berike beskrivelsen med en standardisert tekst for hvor innbygger kan lese mer om register / forskningsprosjekt / studie / biobank Lenketeksten vil da bli: “Les mer på nettsiden til <uriKortNavn>“ Hvis kortNavn ikke spesifiseres brukes navn i stedet ved berikelse av beskrivelsen. |
beskrivelse | string | Påkrevd | En beskrivelse av register/ forskningsprosjekt/ studie/ biobank |
|
uri | string | Frivillig | URI for å lese med om register/ forskningsprosjekt/ studie/ biobank |
|
Eksempel : Opprette ny part
{
"partKode": "kpr",
"navn": "Kommunalt pasient- og brukerregister",
"beskrivelse": "Dette er en beskrivelse av KPR"
}Response parametere
201 - Created
Oppdater part
Kun aktør som eier en part kan oppdatere denne. Eierskap identifiseres av API klient id for den aktøren som opprettet parten. Det er kun utvalgte felter på en part som kan oppdateres. Alle verdier for
Request parametere
Navn | Type | Påkrevd / Frivillig | Lovlige verdier | Kommentar |
|---|---|---|---|---|
partKode | string | Påkrevd | Eksisterende partKode som eies av aktøren. | PartKode kan ikke endres via APIet. |
navn | string | Påkrevd | Navn på register/ forskningsprosjekt/ studie/ biobank | Det offisielle navnet på parten, dette vil vises til innbygger på Helsenorge. |
kortNavn | string | Frivillig | Ett kortnavn som benyttes om register/ forskningsprosjekt/ studie/ biobank | Hvis angitt sammen med en uri vil kortNavn benyttes til å berike beskrivelsen med en standardisert tekst for hvor innbygger kan lese mer om register / forskningsprosjekt / studie / biobank Lenketeksten vil da bli: “Les mer på nettsiden til <uriKortNavn>“ Hvis kortNavn ikke spesifiseres brukes navn i stedet ved berikelse av beskrivelsen. |
beskrivelse | string | Påkrevd | En beskrivelse av register/ forskningsprosjekt/ studie/ biobank |
|
uri | string | Frivillig | URI for å lese med om register/ forskningsprosjekt/ studie/ biobank |
|
Eksempel : Oppdatere eksisterende definisjon
{
"partKode": "kpr",
"beskrivelse": "Dette er en ny beskrivelse av KPR"
}Response parametere
204 - No Content