Denne service benyttes til at en sagsbehandler kan registrere sig for gæsteadgang til en borger aht. at kunne se eller opdatere data, der er registreret i DFDG på en borger, også selv om borgeren er fraflyttet. F.eks. af journal-, refusions- og revisionsmæssige årsager.
Metoder
Table of Contents | ||
---|---|---|
|
...
GetGaesteadgange (GET /
...
Gaesteadgang/)
Denne metode benyttes til at hente alle gaestadgangeGaesteadgange, for en given borger.
Operation | Endpoint |
---|---|
GET | v1/gaestadgangGaesteadgang/ |
Input
[Personnummer i header]
Output
Element | Type | Detaljer | Forekomst | Beskrivelse | |
---|---|---|---|---|---|
GaestadgangeGaesteadgange | IEnumerable<GaestadgangDto>IEnumerable<GaesteadgangDto> |
| 1 | Samling af generelle statuskommentarer tilknyttet personen ud fra (populært kaldet AMP kommentarfeltet). | Gaestadgang En samling af alle gæsteadgange, der er registreret for en given borger |
(PersonCommentType) | GaestadgangDtoGaesteadgangDto |
| 0 - * |
| |
(MessageIdentifier) | guid | 1 | Unik nøgle | ||
(CommentText) | string | Length: 1-1000 | 1 | Kommentartekst | |
(EventDate) | dateTime |
| 1 | Hændelsesdato for registreringen | |
(CaseWorkerStructure) | RegistrerendeBrugerDto |
| 1 | Registrerende sagsbehandler. | |
| string | Length: 1-140 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. | ||
(CaseWorkerGivenName) | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn | |
(CaseWorkerMiddleName) | string | MaxLength: 40 | 0 - 1 | Sagsbehandlerens mellemnavn. | |
(CaseWorkerSurname) | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. | |
(CaseWorkerRID) | string | Length: 1-64 | 1 | Sagsbehandlerens RID fra medarbejder OCES certifikatetSagsbehandler id. | |
(AuthorityStructure) | RegistrerendeMyndighedDto |
| 1 | Detaljer på myndigheden. | |
(AuthorityCode) | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. | |
(OrganisationTypeIdentifier) | 1 | MyndighedsnavnMyndighedstype. | |||
| string |
| 1 | Myndighedsnavn. |
...
CreateGaesteadgang (
...
POST /
...
Gaesteadgang/
...
)
Denne metode benyttes til at hente en specifik gaestadgang, for en given borger.
Operation | Endpoint |
---|
POST | v1/ |
Gaesteadgang/ |
Input
[Personnummer i headerHeader]
Element
Type
Detaljer
Forekomst
Beskrivelse
GaestadgangId
(MessageIdentifier)
guid
1
Unik nøgle
Gaestadgangskommentar
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
GaestadgangId
Guid
1
Output
CreateGaesteadgangRequest | CreateGaesteadgangRequestDto | 1 | ||
- Gaesteadgangskommentar | string | Length: 1- |
900 | 1 |
Kommentartekst
Registreringstidspunkt
(EventDate)
dateTime
1
Hændelsesdato for registreringen
RegistrerendeBruger
(CaseWorkerStructure)
RegistrerendeBrugerDto
(CaseWorkerStructureType)
1
Registrerende sagsbehandler.
- BrugerFuldtNavn
string
Length: 1-140
Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
- Fornavn
(CaseWorkerGivenName)
string
Length: 1-50
1
Sagsbehandlerens fornavn
- Mellemnavn
(CaseWorkerMiddleName)
string
MaxLength: 40
0 - 1
Sagsbehandlerens mellemnavn.
- Efternavn
(CaseWorkerSurname)
string
Length: 1-40
1
Sagsbehandlerens efternavn.
- BrugerId
(CaseWorkerRID)
string
Length: 1-64
1
Sagsbehandlerens RID fra medarbejder OCES certifikatet.
RegistrerendeMyndighed
(AuthorityStructure)
RegistrerendeMyndighedDto
1
Detaljer på myndigheden.
- Organisationskode
(AuthorityCode)
string
Pattern: [-][1]|[0-9]{1,8}
1
Myndighedskode.
- OrganisationType
(OrganisationTypeIdentifier)
1
Myndighedsnavn.
- AuthorityName
string
1
Myndighedsnavn.
GetHistoriskeGaestadgange (GET /gaestadgang/historik)
Denne metode benyttes til at hente historik for alle gaestadgange, for en given borger.
...
Operation
...
Endpoint
...
GET
...
v1/gaestadgang/historik
Input
[Personnummer i header]
...
Begrundelse for behovet for adgang til borger |
Output
Task<Guid> hvor guid er gæsteadgangens id.
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreateGaesteadgangResponse | CreateGaesteadgangResponseDto | 1 | ||
- Servicekvittering | ServicekvitteringDto | 1 | ||
- - Registreringstidspunkt | dateTime | 1 | Tidspunkt for transaktionen eller registrering. | |
- - RegistreringsId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Unik identifikation af transaktion eller registrering. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
60007 | The person with specified cpr is dead | The person with specified cpr is dead |
4933 | The comment text cannot contain html tags | The comment text cannot contain html tags |
4922 | User is not allowed to access the specified person | User is not allowed to access the specified person |
CreateGaesteadgang (POST /Gaesteadgang/legacy)
Metoden kan kun benyttes af DFDG Classic, i den overgangsperiode PersonStatusCommentService vedligeholdes for eksternt brug.
Operation | Endpoint |
---|---|
POST | v1/Gaesteadgang/legacy |
Input
[Personnummer i Header]
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
GaestadgangshistorikResponse
GaestadgangshistorikResponseDto
CreateGaesteadgangRequest |
CreatePersonGuestAccessRequest) |
IEnumerable<GaestadgangshistorikDto>
(CommentTypeCollection)
0 - 1
Liste af historiske gaestadgange.
- GaestadgangId
(CommentIdentifier)
guid
1
Identifier for gaestadgang
- Gaestadgangskommentar
CreateGaesteadgangRequestDto | 1 | ||
- Gaesteadgangskommentar (GuestAccessCommentText) | string | Length: 1- |
900 | 1 |
Gaestadgangskommentartekst
- Registreringstidspunkt
(EventDate)
dateTime
1
Hændelsesdato for registreringen
- Berigtigelseskommentar
(CorrectionComment)
string
0 - 1
Kommentar til berigtigelse af en registrering.
- - BaseType
ServiceModelBase
1
- 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
- - - - - Organisattionskode
Begrundelse for behovet for adgang til borger | |||
- AktivOrganisationKode (AuthorityCode) | string | Pattern: [-][1]|[0-9]{1,8} | 1 |
Myndighedskode. |
- |
date-time
1
Tidspunkt for registrering i DFDG
CreateGaestadgang (POST /gaestadgang/)
...
Operation
...
Endpoint
...
POST
...
v1/Gaestadgang/
Input
[Personnummer i Header]
Element
Type
Detaljer
Forekomst
Beskrivelse
CreateGaestadgangRequest
(CreatePersonGuestAccessRequest)
CreateGaestadgangRequestDto
1
- Gaestadgangskommentar
(GuestAccessCommentText)
string
Length: 1-900
1
AktivOrganisationType (OrganisationTypeIdentifier) | 1 | Myndighedstype. |
Output
Task<Guid> hvor guid er gæstadgangens gæsteadgangens id.
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
CreateGaesteadgangResponse |
CreateGaesteadgangResponseDto | 1 |
(ServiceReceipt) | ServicekvitteringDto | 1 |
(EventDate) | dateTime | 1 | Tidspunkt for transaktionen eller registrering. |
(MessageIdentifier) | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Unik identifikation af transaktion eller registrering. |
Fejlkoder
...
Fejlkode | Fejltekst | Beskrivelse |
---|
Findes allerede i BorgerKommunikation med en anden kode
60007 | The person with specified cpr is dead | The person with specified cpr is dead |
4933 | The comment text cannot contain html tags | The comment text cannot contain html tags |
4922 | User is not allowed to access the specified person | User is not allowed to access the specified person |