VisiteringOgStatus.HelbredsbegraensningService (Version 1, 2023-4)

A-kasse

JobCenter

STAR

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

response

uuid

1

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

A-kasse

JobCenter

STAR

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

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

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

A-kasse

JobCenter

STAR

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

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

A-kasse

JobCenter

STAR

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

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

4743

Registreringen kan ikke slettes

Registreringen kan ikke slettes

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

A-kasse

JobCenter

STAR

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

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

OrganisationTypeCodeList

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

RequestUserTypeCodeList

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

email

0 - 1

Brugers e-mail.

-    -    -    -    -    -    brugerOrganisation

BrugerOrganisationDto

1

-    -    -    -    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registrering i DFDG

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