Terug naar index  <<  Terug naar templates

active Template  CDA recordTarget SDTC NL BSN Minimal

Id 2.16.840.1.113883.2.4.3.11.60.3.10.2
ref
zib2017bbr-
Ingangsdatum 2018‑06‑11
Status active Actief Versielabel
Naam CDArecordTargetSDTC-NL-BSN-Minimal Weergavenaam CDA recordTarget SDTC NL BSN Minimal
Omschrijving
De persoon van wie gegevens zijn opgenomen in het bericht/document, aangeduid met een verplichte BSN en minimaal aanvullende gegevens. Wijziging ten opzichte van de vorige versie is dat het BSN welke 1..1 R was, nu ook echt van @nullFlavor te voorzien is. Dit kon technisch niet omdat @root en @extension verplicht waren gesteld.
Classificatie CDA header level template
Open/gesloten Open (ook andere dan gedefinieerde elementen zijn toegestaan)
Gebruikt door / Gebruikt
Gebruikt door 1 transactie en 3 templates, Gebruikt 2 templates
Gebruikt door als Naam Versie
DVZA-VZVZ-transaction-6 Transactie draft Opleveren Correspondentie 2020‑07‑28 10:16:49
2.16.840.1.113883.2.4.3.111.3.3.10.9042 Inclusie draft Organizer Correspondentie 2019‑07‑30 09:08:31
2.16.840.1.113883.2.4.3.111.3.3.10.9041 link draft VZVZ Opleveren Correspondentie 2019‑07‑25 16:02:15
2.16.840.1.113883.2.4.3.111.3.22.10.3 link draft BatchWrapper Responding DVZA Correspondentie 2020‑07‑28 11:36:03
Gebruikt als Naam Versie
2.16.840.1.113883.2.4.3.11.60.3.10.1.101 Inclusie review address NL - generic 2018‑06‑11
2.16.840.1.113883.2.4.3.11.60.3.10.1.100 Inclusie draft name person NL - generic 2018‑06‑11
Relatie Specialisatie: template 2.16.840.1.113883.2.4.3.11.60.3.10.1 CDA recordTarget SDTC NL (2017‑06‑02)
ref
zib2015bbr-

Specialisatie: template 2.16.840.1.113883.10.12.601 CDA recordTarget SDTC (2005‑09‑07)
ref
ad1bbr-

Adaptatie: template 2.16.840.1.113883.10.12.101 CDA recordTarget (2005‑09‑07)
ref
ad1bbr-
Voorbeeld
Voorbeeld
<recordTarget>
  <patientRole>
    <id extension="100197243" root="2.16.840.1.113883.2.4.6.3"/>    <patient classCode="PSN" determinerCode="INSTANCE">
      <name>
        <family qualifier="VV">de </family>        <family qualifier="BR">Jong</family>      </name>
      <administrativeGenderCode codeSystem="2.16.840.1.113883.5.1" code="M"/>      <birthTime value="19670330"/>    </patient>
  </patientRole>
</recordTarget>
Item DT Card Conf Omschrijving Label
hl7:recordTarget
(CDAdotsmal)
hl7:patientRole
1 … 1 M (CDAdotsmal)
hl7:id
II.NL.BSN 1 … 1 R (CDAdotsmal)
@root
0 … 1 F 2.16.840.1.113883.2.4.6.3
@extension
0 … 1   Burgerservicenummer. Een BSN is N8..9 maar is in berichten altijd N9, eventueel via een voorloopnul.
@nullFlavor
0 … 1   Relevant als het burgerservicenummer ontbreekt (nullFlavor="UNK") of wordt gemaskeerd (nullFlavor="MSK")
hl7:addr
AD.NL 0 …  (CDAdotsmal)
Inclusie van 2.16.840.1.113883.2.4.3.11.60.3.10.1.101 address NL - generic (2018‑06‑11)
@use
set_cs 0 … 1  
  CONF
De waarde van @use moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.40.2.20.5.3 AdresSoortCodelijst (2017‑12‑31)
hl7:streetName
ST 0 … 1 R Straatnaam. Als het adres een postbusnummer is dan dient hier het woord “Postbus” te staan. Als het adres een antwoordnummer is, dan dient hier het woord “Antwoordnummer” te staan. (CDAdotsmal)
  Voorbeeld <streetName>Heereweg</streetName>
hl7:houseNumber
ST 0 … 1 R Het element houseNumber moet het huisnummer bevatten. Het huisnummer kan niet-numerieke gedeelten bevatten die het adres mede identificeren, bijv. "23a", maar alleen als de bron deze niet gescheiden kan aanbieden. Huisletter dient indien mogelijk in het element buildingNumberSuffix te worden doorgegeven. Gegevens zoals "to" (woonboten) of "3 hoog achter" maken geen deel uit van dit attribuut. Dit type gegevens is elders in het AD datatype opgenomen. (CDAdotsmal)
  Voorbeeld <houseNumber>13</houseNumber>
hl7:buildingNumberSuffix
ST 0 … 1 R Het element buildingNumberSuffix bevat, indien aanwezig, huisletter en/of huisnummertoevoeging. Het element houseNumber kan dan alleen het numerieke huisnummer bevatten.

Export

  • Als er zowel een huisletter als een huisnummertoevoeging bekend is, dan komt de huisletter eerst, dan een spatie en tenslotte de huisnummertoevoeging.
  • Als er alleen een huisletter bekend is, wordt deze in de buildingNumberSuffix doorgegeven. Er hoeft geen spatie achter.
  • Als er alleen een huisnummertoevoeging bekend is, wordt deze in de buildingNumberSuffix doorgegeven met een spatie ervoor ter indicatie van een lege huisletter

Import

  • Als buildingNumberSuffix geen spatie bevat, dan geldt de gehele waarde als huisletter.
  • Als buildingNumberSuffix wel een spatie bevat, dan wordt het gedeelte voor de eerste spatie als huisletter geïmporteerd, en het gedeelte na de eerste spatie (de rest) als huisnummertoevoeging.
(CDAdotsmal)
  Voorbeeld
Huisletter B
<buildingNumberSuffix>B</buildingNumberSuffix>
  Voorbeeld
Huisnummertoevoeging rood
<buildingNumberSuffix> rood</buildingNumberSuffix>
  Voorbeeld
Huisletter B, Huisnummertoevoeging rood
<buildingNumberSuffix>B rood</buildingNumberSuffix>
hl7:additionalLocator
ST 0 … 1 R Aanvullende locatieaanduidingen aanvullend op het postadres. Kan de waarden 'to' (tegenover) of 'by' (bij) zijn. (CDAdotsmal)
  CONF
elementinhoud moet "to" zijn
-of-
elementinhoud moet "by" zijn
hl7:postalCode
ADXP 0 … 1 R Postcode van het adres. Indien dit een Nederlandse postcode is, dan is het formaat 'nnnn AA' (met spatie). Het is mogelijk om Nederlandse postcodes te coderen volgens NEN5825 (OID 2.16.840.1.113883.2.4.4.15). Let op dat in dit codestelsel Nederlandse postcodes zonder spaties worden gehanteerd. (CDAdotsmal)
@code
0 … 1   Gecodeerde postcode. Formaat Nederlandse postcodes volgens NEN5825 is 'nnnnAA'
@codeSystem
0 … 1   Codesysteem voor gecodeerde postcodes. Voor Nederlandse postcodes is dit NEN5825 OID: 2.16.840.1.113883.2.4.4.15
hl7:county
ADXP 0 … 1 R Relevant voor personen. In Nederland wordt dit element gebruikt om de gemeente van inschrijving door te geven (in andere landen kan een ander type administratieve eenheid binnen een staat/provincie gebruikt worden). De gemeente kan, maar hoeft niet, overeen te komen met de stad. Sommige gemeenten, bijvoorbeeld "Waterland", hebben een naam die geheel afwijkt van de steden die erin gelegen zijn. In het HL7-berichtenverkeer wordt de gemeente in Nederland alleen gebruikt in het kader van wettelijke identificatie van personen. Het datatype van county is coded string (SC). Als de gemeente gecodeerd wordt, dan dient Basisregistratie Personen (BRP)/ Gemeentelijke basisadministratie (GBA) tabel 33 (OID 2.16.840.1.113883.2.4.6.14) gebruikt te worden. Code 0000 zoals aanwezig in de GBA Tabel 33 mag onder geen enkele omstandigheid voorkomen in een HL7 versie 3 bericht. Het equivalent van 0000 (onbekende gemeente) in HL7 versie 3 is het niet-opnemen van een code. (CDAdotsmal)
hl7:city
ST 0 … 1 R Plaats (CDAdotsmal)
hl7:country
ADXP 0 … 1 R Land volgens Basisregistratie Personen (BRP)/ Gemeentelijke basisadministratie (GBA) tabel 34 Landen (2.16.840.1.113883.2.4.4.16.34) of ISO 3166‐2 alpha (1.0.3166.1.2.2). De landnaam in de text() node is verplicht als het element country wordt gebruikt, maar coderen van het land is niet verplicht. (CDAdotsmal)
@code
0 … 1   Gecodeerd land.
@codeSystem
0 … 1   Codesysteem voor gecodeerd land.
  Voorbeeld
BRP/GBA Tabel 34 Landen
<country code="6030" codeSystem="2.16.840.1.113883.2.4.4.16.34">Nederland</country>
  Voorbeeld
ISO 3166-2 alpha
<country code="NL" codeSystem="1.0.3166.1.2.2">Nederland</country>
hl7:unitID
ST 0 … 1 Een geheel of gedeeltelijke beschrijving van de ligging van een object indien dit niet kan worden aangegeven met de andere adresaanduidingen. NB: het Nederlandse datatype AD versie 1 heeft ook een element <desc/> wat in aanmerking zou kunen komen voor dit type informatie, maar gebruik daarvan wordt niet geadviseerd omdat dit gebruik met CDA zou schaden. In CDA zou het wel als extensie kunnen worden gebruikt. Het internationale datatype AD voorziet niet in een element dat direct geschikt is voor Locatieomschrijving zoals hier bedoeld en dit element moet dan ook als een vorm van misbruik van een niet-gebruikt veld worden gezien. (CDAdotsmal)
hl7:useablePeriod
IVL_TS 0 … 1 Het element useablePeriod duidt de periode aan waarin dit adres 'in gebruik'/geldig is/was. De opties zijn:
  • Er is geen useablePeriod element: het betreffende adres is in principe onbeperkt geldig.
  • Er is een onder- en een bovengrens: het adres was geldig in de aangeduide periode.
  • Er is alleen een ondergrens: het adres is geldig sinds de aangeduide datum.
  • Er is alleen een bovengrens: het adres was geldig t/m de aangeduide datum.
(CDAdotsmal)
  Constraint In elke situatie waar één of meer adressen worden doorgegeven, moet minimaal het adres worden aangeduid dat op het moment van verzenden geldig/actueel is. Vervallen adressen kunnen dus alleen worden doorgegeven als het betreffende berichtelement herhalend is (dus met cardinaliteit > 1). Adressen mogen ook in de toekomst geldig worden of vervallen als bijvoorbeeld verhuizing reeds bekend is.
hl7:patient
1 … 1 R (CDAdotsmal)
hl7:name
PN.NL 1 … 2 R Maximaal 2 namen: officiële naam uit de GBA/BRP (@use = 'OR') en/of de naam "zoals de persoon bekend staat" (@use != 'OR'), bijvoorbeeld een roepnaam of een andere combinatie van geslachtsnaam/geslachtsnaam partner. (CDAdotsmal)
Inclusie van 2.16.840.1.113883.2.4.3.11.60.3.10.1.100 name person NL - generic (2018‑06‑11)
@use
set_cs 0 … 1   In principe kan van elke Person Name worden aangegeven in welke situatie deze gebruikt kan worden. Voor Nederland is besloten dat de volgende naamgebruikstypen voor kunnen komen:
  • L - Reguliere naam. De naam zoals die door de persoon (entiteit) gevoerd wordt. De afkorting 'L' stond oorspronkelijk voor Legal (wettelijk), maar feit is dat hier ook componenten in voor mogen komen (zoals een roepnaam), die niet wettelijk zijn vastgelegd. Dit naamgebruikstype is het standaardtype als geen type wordt doorgegeven.
  • A - Pseudoniem. Een artiestennaam, 'schuilnaam' of tijdelijke naam voor een persoon (entiteit). Deze wijkt dus af van de regulier gevoerde naam en wordt bijvoorbeeld gebruikt om iemands identiteit te verbergen (in verband met privacy) of als tijdelijke naam wanneer de echte niet bekend is ('John Doe').
  • OR - Wettelijk geregistreerde naam. De naam met de exacte componenten zoals deze voorkomen in het bevolkingsregister van het betreffende land. Voor Nederland is dit het Gemeentelijke Basisadministratie (GBA) of Basisregistratie Personen (BRP) of Register niet-ingezetenen (RNI). Dit is de naam zoals die wordt geretourneerd indien een BSN met succes wordt geverifieerd.
  CONF
@use moet "L" zijn
of
@use moet "A" zijn
of
@use moet "OR" zijn
Keuze 0 … *
Minimaal één van de elementen voornaam, roepnaam of initialen en minimaal een geslachtsnaam of geslachtsnaam partner, eventueel met voorvoegsels moet aanwezig zijn.
Elementen om uit te kiezen:
  • hl7:given[@qualifier='BR']
  • hl7:given[@qualifier='CL']
  • hl7:given[@qualifier='IN']
  • hl7:given[not(@qualifier)]
  • hl7:prefix[.[not(@qualifier)] | .[tokenize(@qualifier,'\s')='VV'][following-sibling::hl7:family]]
  • hl7:family[not(@qualifier)]
  • hl7:prefix[tokenize(@qualifier,'\s')='VV'][following-sibling::hl7:family[1][@qualifier='BR']]
  • hl7:family[@qualifier='BR']
  • hl7:delimiter[not(@nullFlavor)]
  • hl7:prefix[tokenize(@qualifier,'\s')='VV'][following-sibling::hl7:family[1][@qualifier='SP']]
  • hl7:family[@qualifier='SP']
  • hl7:suffix[not(@nullFlavor)]
hl7:given
ENXP 0 … 1 Bevat de voornamen van een persoon. Het qualifier 'BR' duidt een officiële voornaam aan (CDAdotsmal)
waar [@qualifier='BR']
@qualifier
set_cs 1 … 1 F BR
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <given qualifier="BR">Maria</given>
hl7:given
ENXP 0 … 1 Bevat de roepnaam van een persoon. Het qualifier 'CL' duidt een roepnaam aan (CDAdotsmal)
waar [@qualifier='CL']
@qualifier
set_cs 1 … 1 F CL
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <given qualifier="CL">Ria</given>
hl7:given
ENXP 0 … 1 Bevat de voorletters van een persoon. Een afsluitende punt moet expliciet worden vermeld. De qualifier heeft de waarde "IN" voor de initialen (CDAdotsmal)
waar [@qualifier='IN']
@qualifier
set_cs 1 … 1 F IN
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <given qualifier="IN">M.</given>
hl7:given
ENXP 0 … 1 Voornaamdeel van ongedefinieerd type. Bij voorkeur alleen met type gebruiken. (CDAdotsmal)
waar [not(@qualifier)]
hl7:prefix
ENXP 0 … 1 Prefixdeel van ongedefinieerd type, of van type voorvoegsel gevolgd door een achternaam. Element prefix bij voorkeur alleen met type gebruiken. (CDAdotsmal)
waar [. [not(@qualifier)] of
[tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family]]
hl7:family
ENXP 0 … 1 Achternaamdeel van ongedefinieerd type. Bij voorkeur alleen met type gebruiken. (CDAdotsmal)
waar [not(@qualifier)]
hl7:prefix
ENXP 0 … 1 C Bevat voorvoegsels van de geslachtsnaam en moet direct voorafgaand aan de geslachtsnaam in family staan (CDAdotsmal)
waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='BR']]
@qualifier
set_cs 1 … 1 F VV
  Merk op dat @qualifier="VV BR" ook is toegestaan.
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <prefix qualifier="VV">van der </prefix>
hl7:family
ENXP 0 … 1 C Bevat de geslachtsnaam van een persoon. Het qualifier 'BR' duidt een geslachtsnaam aan (CDAdotsmal)
waar [@qualifier='BR']
@qualifier
cs 1 … 1 F BR
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <family qualifier="BR">Lelie</family>
hl7:delimiter
ENXP 0 … 1 Een delimiter heeft geen speciale betekenis als onderdeel van een Person Name, anders dan het doorgeven van een (stukje) letterlijke tekst dat in de geschreven naam voorkomt. Een delimiter moet altijd op de plaats in de Person Name staan waar de tekst ook geschreven zou worden. Er zijn geen impliciete spaties, dus als er normaal gesproken een spatie voor of achter geschreven wordt, dan moet deze expliciet worden meegegeven. Voorbeelden van delimiters zijn:
  • Het streepje '-' tussen de eigen achternaam en de partnernaam (of andersom).
  • De komma plus spatie ', ' die tussen de naam en bepaalde achtervoegsels komt.
  • De tekst ', geb. ' of ', e.v. ' die soms gebruikt wordt bij eigen- respectievelijk partnernaam.
Merk op: de spatie tussen een voorvoegsel en de achternaam is geen delimiter, het behoort bij het voorvoegsel. Dit geldt tevens voor andere scheidingstekens behorende bij een voorvoegsel zoals in de naam "D'Artagnan".
(CDAdotsmal)
@nullFlavor
0 NP NP/niet aanwezig
hl7:prefix
ENXP 0 … 1 Bevat voorvoegsels van de geslachtsnaam van partner en moet direct voorafgaand aan de geslachtsnaam partner in family staan (CDAdotsmal)
waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='SP']]
@qualifier
set_cs 1 … 1 F VV
  Merk op dat @qualifier="VV SP" ook is toegestaan.
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <prefix qualifier="VV">van </prefix>
hl7:family
ENXP 0 … 1 Bevat de geslachtsnaam partner van een persoon. Het qualifier type 'SP' duidt een geslachtsnaam partner aan (CDAdotsmal)
waar [@qualifier='SP']
@qualifier
cs 1 … 1 F SP
@nullFlavor
0 NP NP/niet aanwezig
  Voorbeeld <family qualifier="SP">Putten</family>
hl7:suffix
ENXP 0 … * Een suffix heeft betrekking op een deel van de naam dat hoort bij één of meer andere naamdelen en daar achter wordt geschreven. In Nederland zijn als achtervoegsel alleen academische titels toegestaan. Enkele regels voor person name parts van type suffix:
  • Een suffix moet altijd direct achter de naamdelen worden geplaatst waar het betrekking op heeft (d.w.z. waar het normaal gesproken wordt geschreven).
  • Er is geen impliciete spatie als tussenruimte met het eraan voorafgaande name part, d.w.z. een spatie voor het achtervoegsel moet expliciet worden vermeld!
  • De aard van het achtervoegsel kan verder worden aangeduid door het optionele attribuut qualifier te gebruiken.

Een person name part van type suffix dat zonder qualifier wordt gebruikt, moet worden beschouwd als een niet nader bepaald achtervoegsel. Ook het gebruik van (vaak Amerikaanse) termen als ' Jr.', ' Sr.' of ' III' valt in deze categorie.

Er is geen regel voor het aantal achtervoegsels dat wordt gecombineerd in één element. D.w.z. dat " MSc" en " MD" apart kunnen worden doorgegeven, maar ook gecombineerd als " MSc MD".

(CDAdotsmal)
@qualifier
cs 0 … 1 F AC
@nullFlavor
0 NP NP/niet aanwezig
hl7:validTime
IVL_TS 0 … 1 Dit is een optioneel XML-element binnen de Person Name en duidt de periode aan waarin deze naam 'in gebruik'/geldig was voor de betreffende persoon. De opties zijn:
  • Er is geen validTime element: de betreffende naam is in principe onbeperkt geldig.
  • Er is een onder- en een bovengrens: de naam was geldig in de aangeduide periode.
  • Er is alleen een ondergrens: de naam is geldig sinds de aangeduide datum.
  • Er is alleen een bovengrens: de naam was geldig t/m de aangeduide datum.
Dit element van Person Name kan worden gebruikt om aan te geven dat een persoon gedurende diens leven één of meer keer van naam veranderd is. Dit gebeurt o.a. bij:
  • Adoptie van een baby, waarbij het de achternaam van de adoptieouders verkrijgt.
  • Huwelijk, waarbij de partnernaam kan worden toegevoegd aan de eigen naam.
  • Scheiding, waarbij een eerder aangenomen partnernaam juist weer vervalt.
  • Personen die om andere redenen hun voor- of achternaam veranderen.
Merk op dat veel patiëntregistratiesystemen niet echt een historie (met ingangsdatum) bijhouden van de patiëntnaam. Wel wordt vaak een 'audit trail' (wijzigingshistorie) van de patiëntgegevens in het algemeen bijgehouden. Indien gewenst zou daaruit een historie van de persoonsnaam kunnen worden afgeleid, hoewel het natuurlijk ook mogelijk is om alleen de actuele naam door te geven (en dus geen validTime te gebruiken).
(CDAdotsmal)
  Constraint In elke situatie waar één of meer persoonsnamen worden doorgegeven, moet minimaal de naam worden aangeduid die op het moment van verzenden geldig/actueel is. Vervallen namen kunnen dus alleen worden doorgegeven als het betreffende berichtelement herhalend is (dus met cardinaliteit > 1). In tegenstelling tot de situatie bij organisatienamen is het bij persoonsnamen niet toegestaan dat de ondergrens of de bovengrens van een validTime in de toekomst ligt. Er kan dus geen 'geplande' nieuwe naam of het 'gepland vervallen' van de huidige naam worden doorgegeven voor persoonsnamen.
  Schematron assert role red error  
  test not(*) or (hl7:given and hl7:family)  
  Melding In een gestructureerde naam moet minimaal één voornaam, initiaal of roepnaam en minimaal één geslachtsnaam of geslachtsnaam partner van een persoon aanwezig zijn, inclusief voorvoegsel(s) indien van toepassing  
hl7:administrativeGenderCode
CE 1 … 1 R (CDAdotsmal)
  CONF
De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1 GeslachtCodelijst (2017‑12‑31)
hl7:birthTime
TS 0 … 1 R (CDAdotsmal)
sdtc:multipleBirthInd
BL 0 … 1 (CDAdotsmal)