1.3 | Schrijfwijze van objecten

Twiin bevat in de verschillende hoofdstukken objecten zoals afspraken, eisen, specificaties en richtlijnen. Om deze op een heldere, eenduidige en juridisch duidelijke manier te duiden voor de Twiin Deelnemer, Twiin Dienstverlener en GTK Leverancier en GTK Beheerder wordt gebruik gemaakt van RFC 2119. Dit is een richtlijn die vastlegt hoe woorden als MOET (MUST), ZOU MOETEN (SHOULD) en MAG (MAY) moeten worden geïnterpreteerd.

Vereiste-niveaus

RFC 2119-term

Nederlandse term

Interpretatie

MUST / REQUIRED / SHALL

MOET / VERPLICHT / ZAL

Een absolute vereiste.

MUST NOT / SHALL NOT

MAG NIET / ZAL NIET

Een absoluut verbod. Binnen Twiin is het omschrevene niet toegestaan.

SHOULD / RECOMMENDED

ZOU MOETEN / AANBEVOLEN

Dit is een algemene vereiste die ondersteund zou moeten worden. Er kunnen valide redenen zijn om een onderdeel wel verplicht te stellen.

Zo kan een vereiste worden versterkt bij een (zorg)toepassing in Twiin. Een eis met het niveau ‘ZOU MOETEN’ kan binnen de BgZ wel degelijk noodzakelijk zijn.

SHOULD NOT / NOT RECOMMENDED

ZOU NIET MOETEN / NIET AANBEVOLEN

Dit is ongewenst, tenzij er een valide reden is om het in een specifiek geval toe te laten.

MAY / OPTIONAL

MAG / OPTIONEEL

Een vrije keuze, een optie.

Meta-model voor objecten

Objecten die zijn opgenomen in Twiin kennen verschillende attributen om helderheid te geven over hoe en waar ze van toepassing zijn. De attributen zijn alleen zichtbaar als ze relevant zijn en een waarde hebben.

Attribuut

Toelichting

Waardes

ID

De codering van objecten helpt om ze vindbaar en overzichtelijk te maken.

Twiin-objecten (TW) zijn geschreven volgens onderstaande logica: TW-CATEGORIE-SUBCATEGORIE-VOLGNUMMER.

Waar een categorie bijvoorbeeld een communicatiepatroon (P) of generieke functie (F) kan zijn en een subcategorie een specifieke functie daarbinnen, zoals Netwerkbeveiliging (NB).

Naam

De naam van het object.


Soort

Dit geeft aan wat voor soort object het betreft.

Eis Specificatie Richtlijn Afspraak  

Status

Dit attribuut geeft de status van het object weer:

  • Is een object, zoals een eis geldend? Dan heeft het de status ‘Normatief’.

  • Is het nog onderdeel in één van de fases van ontwikkeling en toetsing, dan kan het de status ‘Trial’, ‘Candidate’, ‘Draft' of ‘Informative’ bevatten.

  • Is een object niet (meer) geldig, dan kent het de status ‘Uitgefaseerd’ of ‘Vervallen’.

Uitgefaseerd Normatief Trial Candidate Draft Informative Vervallen  

Omschrijving

Omschrijving van het object met vereiste-niveau in de lopende tekst.


Toelichting

Toelichting op het object met mogelijk aanvullende eisen, maatregelen en best practices.


Vereiste

Deze waarde geeft het vereiste-niveau aan van het object. Zie hiervoor ‘Vereiste-niveaus’.

MOET ZOU MOETEN MAG NIET ZOU NIET MOETEN MAG  

Implicatie bij toepassing

Aanvullende informatie wanneer het object onderdeel is van een (zorg)toepassing, zoals BgZ.

Als aanvullende informatie beschikbaar is, zal dit attribuut zichtbaar zijn.


Rol

Niet elk object is van toepassing bij elke rol. Het atribuut ‘rol’ geeft duiding aan wie dit dient te ondersteunen of implementeren.

GTK GTK Beheerder Twiin Organisatie Twiin Deelnemer Twiin Dienstverlener  

Bedrijfsrol

Bij een toepassing kunnen ook aanvullende rollen betrokken zijn. Deze worden weergegeven via dit attribuut.

Nieuwe behandelaar Verwijzer Dossierhouder  

Functie (F)

Dit attribuut geeft aan op welke generieke functie het object betrekking heeft.


Identificatie Authenticatie Autorisatie Behandelrelatie Toestemming Logging Adressering Localisatie Transparantie Netwerkbeveiliging Routering  

Patroon (P)

Dit attribuut geeft aan op welk communicatiepatroon het object betrekking heeft.

Notified Pull Pull Indexed Pull Push  

Actor

Dit attribuut geeft aan op welke actor het object betrekking heeft.

GTK Ontvanger GTK Verzender EPD Ontvanger EPD Verzender  

Toepassing (T)

Dit zijn objecten die voor een specifieke toepassing gelden.

BgZ Beelden Correspondentie  

Referenties

Dit betreft verwijzingen binnen en buiten het stelsel, gerelateerd aan het object.


Toetsingscategorie

Vindt er een vorm van toetsing zoals validatie en kwalificatie plaats en zo ja, bij wie?

Geen Via Twiin Via programma Via (kwaliteits)richtlijn Via Nictiz Via NTV  

Toetsingsvorm

Op welke wijze wordt dit object getoetst:

  • Technische toets

  • Functionele toelichting

  • Zelfverklaring

  • (keten)test bij implementatie

  • Externe verklaring, zoals bijvoorbeeld voor NEN 7510 'Verklaring van Toepasselijkheid'.

Technisch Functioneel Zelfverklaring (Keten)test Externe verklaring  

Niveau

Een object kan op verschillende niveaus gelden:

  • Specifiek: Het betreft een afgebakend object binnen Twiin, zoals een (zorg)toepassing.

  • Generiek: Het betreft een object die van toepassing is door Twiin heen, en geldt voor alle onderliggende onderdelen.

  • Landelijk: Dit betreft een landelijk object, zoals afspraken, eisen en specificaties waar stelsels naar kunnen verwijzen.

Specifiek Generiek Landelijk