Borgerindsats.RehabiliteringsforloebService (Version 1, 2024-2)

Borgerindsats.RehabiliteringsforloebService (Version 1, 2024-2)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateRehabiliteringsforloebMedId (POST /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})

Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen

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

 

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

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

rehabiliteringsforloebId [Path]

uuid

 

1

Nøgle på forløbet. Hvis den ikke er angivet sætter DFDG en automatisk.

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. Requestid gemmes kun i 7 dage

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

9323

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

9348

Det angivne RehabiliteringsforloebId findes allerede i systemet

Det angivne RehabiliteringsforloebId findes allerede i systemet

UpdateRehabiliteringsforloeb (PUT /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})

Opdaterer et rehabiliteringsforløb

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

 

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

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

rehabiliteringsforloebId [Path]

uuid

 

1

Nøgle på forløbet.

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. Requestid gemmes kun i 7 dage

requestBody

UpdateRehabiliteringsforloebRequestDto

 

1

 

-    rehabiliteringsforloebStatus

RehabiliteringsforloebStatusCodeList

 

1

 

-    indstillingId

uuid

 

0 - 1

Reference til indstilling. Kan hentes via RecommendeInitiativeService

-    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

GetRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb/{rehabiliteringsforloebId})

Henter et rehabiliteringsforløb

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

 

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

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

rehabiliteringsforloebId [Path]

uuid

 

1

Nøgle på forløbet. Hvis den ikke er angivet hentes den seneste ud fra oprettelsestidpunkt.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetRehabiliteringsforloebResponseDto

 

1

 

-    rehabiliteringsforloeb

RehabiliteringsforloebDto

 

0 - 1

 

-    -    rehabiliteringsforloebId

uuid

 

1

Nøgle på forløbet.

-    -    rehabiliteringsforloebStatus

RehabiliteringsforloebStatusCodeList

 

1

 

-    -    indstillingId

uuid

 

0 - 1

Reference til indstillingen. Kan hentes via RecommendedInitiativeService.orløbet.

-    -    screeningId

uuid

 

0 - 1

Reference til borgers Min situation, som teknisk er en Screening, der kan hentes via Screeningsservice.

-    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

-    -    oprettelsesdato

date-time

 

1

Oprettelsesdato i DFDG

-    -    senesteOpdateringsdato

date-time

 

1

Seneste opdateringsdato i DFDG

-    -    dokumenter

RehabiliteringsdokumentMetadataDtoCollection

 

1

Metadata for alle dokumenter der er knyttet til forløbet.

-    -    -    RehabiliteringsdokumentMetadataDto

RehabiliteringsdokumentMetadataDto

 

0 - *

 

-    -    -    -    dokumentId

uuid

 

1

ID på dokument.

-    -    -    -    dokumentTitel

string

Length: 1-250

1

Titlen på dokument.

-    -    -    -    rehabiliteringsdokumentType

RehabiliteringsdokumentTypeCodeList

 

1

 

-    -    -    -    dokumentExtensionType

DokumentTypeCodeList

 

1

 

-    -    -    -    dokumentStatusType

DokumentStatusCodeList

 

1

 

-    -    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunkt for registering af dokumentet. Er sat af DFDG.

-    -    -    -    senesteOpdateringstidspunkt

date-time

 

1

Tidspunkt for opdatering af dokumentet. Er sat af DFDG.

-    -    -    -    slettetTidspunkt

date-time

 

0 - 1

Tidspunkt for hvornår dokumentet er slettet. Er sat af DFDG.

-    -    -    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar, bruges primært ved lukning af forløb uden afgørelse. Feltet er obligatorisk ved status fejloprettet.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

9322

Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet

Berigtigelseskommentar er påkrævet for rehabiliteringsforløb med status fejloprettet

9332

En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4

En indstilling er påkrævet for RehabiliteringsforloebStatus 3 og 4

9330

Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.

Et rehabiliteringsforløb med RehabiliteringsforloebStatus 1, 2, eller 7, kan ikke have en indstilling.

9323

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

9324

Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt

Kun et rehabiliteringsforløb med RehabiliteringsforloebStatus 4 er tilladt

CreateRehabiliteringsforloeb (POST /v1/Rehabiliteringsforloeb)

Opretter et rehabiliteringsforløb, som er en paraply over den forberedende del og indstillingen

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

 

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

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerindsats.rehabilitering.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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. Requestid gemmes kun i 7 dage

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

9323

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

Kun et rehabiliteringsforløb med rehabiliteringsforløbsstatus 1, 2, 3 eller 7 er tilladt

9348

Det angivne RehabiliteringsforloebId findes allerede i systemet

Det angivne RehabiliteringsforloebId findes allerede i systemet

GetSenesteRehabiliteringsforloeb (GET /v1/Rehabiliteringsforloeb)

Henter et rehabiliteringsforløb

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

 

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

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X