Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 22 additions & 25 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ implementaties getoetst. Op de [technische
uitwerkingen](./technische_uitwerking.md) pagina staat hier informatie over.

```{toctree}
:hidden:
:maxdepth: 1
:caption: 📖 Algemeen
:maxdepth: 1
:hidden:

index.md
inleiding.md
Expand All @@ -45,40 +45,37 @@ afkortingen_en_begrippen.md
```

```{toctree}
:hidden:
:maxdepth: 3
:caption: 📚 Adressering
:maxdepth: 3
:hidden:
:glob:

adressering/01_inleiding.md
adressering/02_termen.md
adressering/03_gebruiks_casussen.md
adressering/04_architectuur.md
adressering/05_koppelvlakken_opzoeken.md
adressering/06_koppelvlakken_registratie.md
adressering/*
```

```{toctree}
:hidden:
:maxdepth: 3
:caption: 📚 Lokalisatie
:maxdepth: 3
:hidden:
:glob:

lokalisatie/01_inleiding.md
lokalisatie/02_termen.md
lokalisatie/03_gebruiks_casussen.md
lokalisatie/04_architectuur.md
lokalisatie/05_technisch.md
lokalisatie/06_koppelvlakken_nvi.md
lokalisatie/07_koppelvlakken_lmr.md
lokalisatie/*
```

```{toctree}
:caption: 📚 Pseudoniemen
:maxdepth: 3
:hidden:
:glob:

pseudoniemen/*
```

```{toctree}
:caption: 🖥 Omgevingen
:maxdepth: 3
:caption: 📚 Pseudoniemen
:hidden:
:glob:

pseudoniemen/01_inleiding.md
pseudoniemen/02_termen.md
pseudoniemen/03_gebruiks_casussen.md
pseudoniemen/04_architectuur.md
pseudoniemen/05_koppelvlakken
omgevingen/*
```
17 changes: 17 additions & 0 deletions docs/omgevingen/01_proeftuin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Proeftuin

De proeftuin omgeving biedt ons en marktpartijen de gelegenheid om koppelvlakken en integraties uitgebreid te testen.
Onze implementaties zijn voornamelijk conceptueel en kunnen in deze omgeving worden gevalideerd.
Houd er rekening mee dat er geen support wordt aangeboden voor deze omgeving en dat de beschikbaarheid kan afwijken.

Om de huidige versies van de verschillende services in de proeftuin te bekijken, kun je de [statuspagina van de proeftuinomgeving](https://status.proeftuin.gf.irealisatie.nl) bezoeken.

Check failure on line 7 in docs/omgevingen/01_proeftuin.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/01_proeftuin.md:7:121 MD013/line-length Line length [Expected: 120; Actual: 184] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md

Via het menu hieronder kun je naar de documentatie van de verschillende generieke functies binnen de proeftuin omgeving navigeren.

```{toctree}
:caption: Inhoud
:maxdepth: 2
:glob:

proeftuin/*
```
4 changes: 4 additions & 0 deletions docs/omgevingen/proeftuin/01_architectuur.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Architectuur

Overzicht van architectuur...

88 changes: 88 additions & 0 deletions docs/omgevingen/proeftuin/02_toestemming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Toestemming

Binnen de proeftuin omgeving is er voor de generieke functie Toestemming een stub implementatie beschikbaar.

Deze stub implementatie demonstreert de functionaliteit van een toestemmingsvoorziening,
waarbij burgers hun toestemmingen kunnen beheren en zorgverleners of it systemen van zorgverleners
deze toestemmingen kunnen opvragen voor autorisatiedoeleinden.

De online toestemmingsvoorziening wordt binnen de proeftuin gebruikt door de NVI.

[//]: # (TODO: Dit wordt momenteel aangepast van NVI naar LMR. )

## Overzicht van services

### Online Toestemmingsvoorziening Portaal

Check failure on line 15 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Headings should be surrounded by blank lines

docs/omgevingen/proeftuin/02_toestemming.md:15 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Online Toestemmingsvoorziening Portaal"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
**URL**: [https://otv-web.proeftuin.gf.irealisatie.nl](https://otv-web.proeftuin.gf.irealisatie.nl)

Het Toestemmingsvoorziening Portaal is een stub implementatie van een webportaal waar burgers hun zorgtoestemmingen kunnen beheren.

Check failure on line 18 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/proeftuin/02_toestemming.md:18:121 MD013/line-length Line length [Expected: 120; Actual: 131] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
Dit portaal simuleert deze functionaliteit voor demonstratie- en testdoeleinden binnen de proeftuin omgeving.

In dit portaal zou een burger normaal met DigiD inloggen, voor deze proeftuin is er een simpele mock login waarbij je fictief BSN invoert.

Check failure on line 21 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/proeftuin/02_toestemming.md:21:121 MD013/line-length Line length [Expected: 120; Actual: 138] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
Hierna kan de burger de kiezen welke zorgaanbieders medische gegevens mogen beschikbaar stellen aan andere zorgverleners.

Het portaal maakt gebruikt van de Pseudoniem Referentie Service Stub om een pseudoniem op te halen voor het fictief ingelogde BSN.

Check failure on line 24 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/proeftuin/02_toestemming.md:24:121 MD013/line-length Line length [Expected: 120; Actual: 130] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
Ook maakt het gebruik van de adresseringsdienst om een lijst van zorgaanbieders op te halen.

Door het wijzigigen van toestemmingen in het portaal, wijzigt ook de data die zichtbaar is in de "Viewer" applicatie.

[//]: # (TODO: Mogelijk linkjes naar de specifieke service pagina toevoegen?)

### Online Toestemmingsvoorziening Stub

Check failure on line 31 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Headings should be surrounded by blank lines

docs/omgevingen/proeftuin/02_toestemming.md:31 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Online Toestemmingsvoorziening Stub"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
**URL**: [https://otv-stub.proeftuin.gf.irealisatie.nl](https://otv-stub.proeftuin.gf.irealisatie.nl)

[//]: # (TODO: Link naar OpenAPI specificatie toevoegen?)

De Online Toestemmingsvoorziening Stub is een API waar toestemmingen van burgers kunnen worden opgevraagd door it systemen van zorgverleners.

Check failure on line 36 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/proeftuin/02_toestemming.md:36:121 MD013/line-length Line length [Expected: 120; Actual: 141] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md

Deze API wordt in de proeftuin gebruikt door de NVI om te controleren of een zorgverlener toestemming heeft om medische gegevens op te vragen voor een specifieke patiënt en gevraagde gegevens.

Check failure on line 38 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Line length

docs/omgevingen/proeftuin/02_toestemming.md:38:121 MD013/line-length Line length [Expected: 120; Actual: 192] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md

## API Documentatie

### Toestemming Stub API Endpoints

[//]: # (TODO: Zie OpenAPI specificatie voor volledige documentatie?)

#### Toestemming Opvragen

Check failure on line 46 in docs/omgevingen/proeftuin/02_toestemming.md

View workflow job for this annotation

GitHub Actions / lint markDown file

Headings should be surrounded by blank lines

docs/omgevingen/proeftuin/02_toestemming.md:46 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "#### Toestemming Opvragen"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
```
POST /permission
Content-Type: application/json

Request Body:
{
"resource": {
"pseudonym": "12345-abcde-67890-fghij",
"org_ura": "12345678",
"org_category": "V1"
},
"subject": {
"org_ura": "87654321"
}
}

Response: true | false
```

**Parameters:**
- **resource.pseudonym** (verplicht): Het pseudoniem van de persoon voor wie toestemming wordt opgevraagd
- **resource.org_ura** (verplicht): URA nummer van de organisatie die de gegevens beheert
- **resource.org_category** (optioneel): Categorie van de organisatie die de gegevens beheert
- **subject.org_ura** (verplicht): URA nummer van de organisatie die toegang vraagt

**Response:**
- `true`: Toestemming is verleend
- `false`: Toestemming is niet verleend

## Testscenario's

### Scenario 1: Nieuwe Toestemming
1. Login op het Toestemmingsvoorziening Portaal
2. Doe A
5. Klik op "Opslaan"
6. Valideer dat toestemming API nu true teruggeeft voor vraag X

### Scenario 2: Toestemming Intrekken
1. Bekijk bestaande toestemmingen in het portaal
2. Klik bij X op "Nee"
3. Klik op "Opslaan"
5. Valideer dat toestemming API nu false teruggeeft voor vraag X