VisiteringOgStatus.HelbredsbegraensningService (Version 1, 2024-2)
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateHelbredsbegraensning (POST /v1/Helbredsbegraensning)
- 2 GetHelbredsbegraensning (GET /v1/Helbredsbegraensning)
- 3 UpdateHelbredsbegraensning (PUT /v1/Helbredsbegraensning/{helbredsbegraensningId})
- 4 DeleteHelbredsbegraensning (DELETE /v1/Helbredsbegraensning/{helbredsbegraensningId})
- 5 GetHelbredsbegraensning (GET /v1/Helbredsbegraensning/{helbredsbegraensningId})
- 6 GetHistoriskeHelbredsbegraensninger (GET /v1/Helbredsbegraensning/historik)
CreateHelbredsbegraensning (POST /v1/Helbredsbegraensning)
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Â | Â | Â | Â | Â | Â |
JobCenter | Â | X | Â | Â | X | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string |  | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max lÊngde for id'et er 46 chars |
requestBody | CreateHelbredsbegraensningRequestDto |  | 1 | Oplysninger om borgers helbredsmÊssige begrÊsninger |
-Â Â Â Â beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 1 | Beskrivelse af helbredsbegraensning. |
-Â Â Â Â beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver. |
-    dokumentationForHelbredsbegrasening | boolean |  | 1 | True, hvis der foreligger dokumention for den helbredsmÊssige begrÊnsning. Ellers false. |
-    startdato | date-time |  | 1 | Startdato for den helbredsmÊssige begrÊnsning |
-    slutdato | date-time |  | 0 - 1 | Slutdato for den helbredsmÊssige begrÊnsning |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid | Â | 1 | Â |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
4405 | Borgeren med det specificerede CPR nummer er dÞd | Borgeren med det specificerede CPR nummer er dÞd |
4668 | Startdato må ikke vÊre historisk | Startdato må ikke vÊre historisk |
4669 | Slutdatoen må ikke ligge fÞr startdatoen | Slutdatoen må ikke ligge fÞr startdatoen |
4742 | Slutdato må ikke vÊre historisk | Slutdato må ikke vÊre historisk |
GetHelbredsbegraensning (GET /v1/Helbredsbegraensning)
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | Â | Â | Â | Â |
JobCenter | Â | X | Â | X | X | X | Â | X |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetHelbredsbegraensningResponseDto | Â | 1 | Â |
-    helbredsbegraensninger | HelbredsbegraensningDtoCollection |  | 1 | Samling af helbredsmÊssige begrÊnsninger registreret på borger |
-Â Â Â Â -Â Â Â Â HelbredsbegraensningDto | HelbredsbegraensningDto | Â | 0 - * | Â |
-    -    -    helbredsbegraensningId | uuid |  | 1 | GUID på den helbredsmÊssige begrÊnsning |
-    -    -    beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 0 - 1 | Selvom der er forekomst 1 på Craate og Update er der 0-1 på Get-metode af hensyn til at kunne udlÊse historiske data |
-Â Â Â Â -Â Â Â Â -Â Â Â Â beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver |
-    -    -    dokumentationForHelbredsbegrasening | boolean |  | 1 | True, hvis der foreligger dokumention for den helbredsmÊssige begrÊnsning. Ellers false. |
-    -    -    startdato | date-time |  | 1 | Startdato for den helbredsmÊssige begrÊnsning |
-    -    -    slutdato | date-time |  | 0 - 1 | Slutdato for den helbredsmÊssige begrÊnsning |
-Â Â Â Â -Â Â Â Â -Â Â Â Â berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
-    -    -    dfdgRegistreringstidspunkt | date-time |  | 1 | HÊndelsesdato for registreringen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
UpdateHelbredsbegraensning (PUT /v1/Helbredsbegraensning/{helbredsbegraensningId})
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Â | Â | Â | Â | Â | Â |
JobCenter | Â | X | Â | Â | X | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
helbredsbegraensningId [Path] | uuid | Â | 1 | Â |
x-requestId [Header] | string |  | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max lÊngde for id'et er 46 chars |
requestBody | UpdateHelbredsbegraensningRequestDto |  | 1 | Oplysninger om borgers helbredsmÊssige begrÊsninger |
-Â Â Â Â beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 1 | Beskrivelse af helbredsbegraensning. |
-Â Â Â Â beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver |
-    dokumentationForHelbredsbegrasening | boolean |  | 1 | True, hvis der foreligger dokumention for den helbredsmÊssige begrÊnsning. Ellers false. |
-    startdato | date-time |  | 1 | Startdato for den helbredsmÊssige begrÊnsning |
-    slutdato | date-time |  | 0 - 1 | Slutdato for den helbredsmÊssige begrÊnsning |
-Â Â Â Â berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
4405 | Borgeren med det specificerede CPR nummer er dÞd | Borgeren med det specificerede CPR nummer er dÞd |
4668 | Startdato må ikke vÊre historisk | Startdato må ikke vÊre historisk |
4669 | Slutdatoen må ikke ligge fÞr startdatoen | Slutdatoen må ikke ligge fÞr startdatoen |
4742 | Slutdato må ikke vÊre historisk | Slutdato må ikke vÊre historisk |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
4589 | Id ikke fundet | Id ikke fundet |
4647 | Startdatoen kan ikke Êndres | Startdatoen kan ikke Êndres |
4762 | Helbredsbegraensningsindholdet må ikke indeholde HTML-tags | Helbredsbegraensningsindholdet må ikke indeholde HTML-tags |
4748 | Slutdato må ikke Êndres | Slutdato må ikke Êndres |
DeleteHelbredsbegraensning (DELETE /v1/Helbredsbegraensning/{helbredsbegraensningId})
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Â | Â | Â | Â | Â | Â |
JobCenter | Â | X | Â | Â | X | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
helbredsbegraensningId [Path] | uuid | Â | 1 | Â |
berigtigelseskommentar [Query] | string | Â | 0 - 1 | Â |
x-requestId [Header] | string |  | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max lÊngde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
4589 | Id ikke fundet | Id ikke fundet |
4668 | Startdato må ikke vÊre historisk | Startdato må ikke vÊre historisk |
4762 | Helbredsbegraensningsindholdet må ikke indeholde HTML-tags | Helbredsbegraensningsindholdet må ikke indeholde HTML-tags |
GetHelbredsbegraensning (GET /v1/Helbredsbegraensning/{helbredsbegraensningId})
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | Â | Â | Â | Â |
JobCenter | Â | X | Â | X | X | X | Â | X |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
helbredsbegraensningId [Path] | uuid | Â | 1 | Â |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetHelbredsbegraensningResponseDto | Â | 1 | Â |
-    helbredsbegraensninger | HelbredsbegraensningDtoCollection |  | 1 | Samling af helbredsmÊssige begrÊnsninger registreret på borger |
-Â Â Â Â -Â Â Â Â HelbredsbegraensningDto | HelbredsbegraensningDto | Â | 0 - * | Â |
-    -    -    helbredsbegraensningId | uuid |  | 1 | GUID på den helbredsmÊssige begrÊnsning |
-    -    -    beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 0 - 1 | Selvom der er forekomst 1 på Craate og Update er der 0-1 på Get-metode af hensyn til at kunne udlÊse historiske data |
-Â Â Â Â -Â Â Â Â -Â Â Â Â beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver |
-    -    -    dokumentationForHelbredsbegrasening | boolean |  | 1 | True, hvis der foreligger dokumention for den helbredsmÊssige begrÊnsning. Ellers false. |
-    -    -    startdato | date-time |  | 1 | Startdato for den helbredsmÊssige begrÊnsning |
-    -    -    slutdato | date-time |  | 0 - 1 | Slutdato for den helbredsmÊssige begrÊnsning |
-Â Â Â Â -Â Â Â Â -Â Â Â Â berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
-    -    -    dfdgRegistreringstidspunkt | date-time |  | 1 | HÊndelsesdato for registreringen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
4589 | Id ikke fundet | Id ikke fundet |
GetHistoriskeHelbredsbegraensninger (GET /v1/Helbredsbegraensning/historik)
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
A-kasse | Â | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | Â | Â | Â | Â |
JobCenter | Â | X | Â | X | X | X | Â | X |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.helbredsbegraensning.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetHelbredsbegraensningHistorikResponseDto | Â | 1 | Â |
-Â Â Â Â helbredsbegraensningerHistorik | HelbredsbegraensningHistorikDtoCollection | Â | 1 | Liste af aktuelle og historiske helbredsbegraensninger. |
-Â Â Â Â -Â Â Â Â HelbredsbegraensningHistorikDto | HelbredsbegraensningHistorikDto | Â | 0 - * | Â |
-    -    -    helbredsbegraensningId | uuid |  | 1 | GUID på den helbredsmÊssige begrÊnsning |
-    -    -    beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 0 - 1 | Selvom der er forekomst 1 på Craate og Update er der 0-1 på Get-metode af hensyn til at kunne udlÊse historiske data |
-Â Â Â Â -Â Â Â Â -Â Â Â Â beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver |
-    -    -    dokumentationForHelbredsbegrasening | boolean |  | 1 | True, hvis der foreligger dokumention for den helbredsmÊssige begrÊnsning. Ellers false. |
-    -    -    startdato | date-time |  | 1 | Startdato for den helbredsmÊssige begrÊnsning |
-    -    -    slutdato | date-time |  | 0 - 1 | Slutdato for den helbredsmÊssige begrÊnsning |
-Â Â Â Â -Â Â Â Â -Â Â Â Â berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
-Â Â Â Â -Â Â Â Â -Â Â Â Â registreringsmetadata | RegistreringsmetadataDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â erSlettet | boolean | Â | 1 | Angiver om registreringen er en sletning |
-    -    -    -    erAktuel | boolean |  | 1 | Det er en rÊkke som er aktuel (kan typisk også ses i PSS). |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrerendeMyndighed | RegistrerendeMyndighedDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrerendeBruger | RegistrerendeBrugerDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â kaldendeBruger | KaldendeBrugerDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerId | string | Length: 1-255 | 1 | Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerEmail | Â | 0 - 1 | Brugers e-mail. | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerOrganisation | BrugerOrganisationDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode for den registrerende bruger. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â dfdgRegistreringstidspunkt | date-time | Â | 1 | Tidspunkt for registrering i DFDG |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |