| Keuze |
1 … 1 |
|
Elementen om uit te kiezen:
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.20.77.10.9410 MP CDA Medicatiegegevens (2022‑11‑18 09:07:07)
ClinicalDocument |
hl7:ClinicalDocument
|
|
1 … 1 |
R |
|
|
hl7:realmCode
|
|
1 … 1 |
M |
Landspecifieke context van het document. Daarmee wordt aangegeven dat de Nederlandse
regels op het gebied van codes en data types van toepassing zijn. Het @code attribuut
bevat de vaste waarde 'NL' |
|
@code
|
CONF |
1 … 1 |
F |
NL |
| |
Voorbeeld |
<realmCode code="NL"/> |
hl7:typeId
|
II |
1 … 1 |
M |
De waarde van dit attribuut (@root en @extension) geeft aan dat de HL7 constraints
voor CDA R2 hier van toepassing zijn.
|
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.1.3 |
@extension
|
st |
1 … 1 |
F |
POCD_HD000040 |
| |
Voorbeeld |
<typeId extension="POCD_HD000040" root="2.16.840.1.113883.1.3"/> |
hl7:templateId
|
II |
1 … 1 |
M |
|
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.3.11.60.20.77.10.9410 |
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.20.77.10.9377 MP CDA Part2Reuse (2021‑06‑17 13:30:37) |
hl7:id
|
II |
1 … 1 |
M |
Met het attribuut @root wordt de applicatie (die voor het maken van het document
was gebruikt) geïdentificeerd. Id is een eenduidige identificatie, die het document
wereldwijd en voor altijd uniek identificeert. Een CDA-document heeft precies één
id. |
|
| |
|
| |
Voorbeeld |
<id extension="a621" root="2.16.840.1.113883.2.4.3.11.999.77.999"/> |
hl7:code
|
CE |
1 … 1 |
M |
Type document. |
|
@displayName
|
|
0 … 1 |
|
Medication section |
@codeSystemName
|
|
0 … 1 |
|
SNOMED CT |
@code
|
CONF |
1 … 1 |
F |
52981000146104 |
@codeSystem
|
1 … 1 |
F |
2.16.840.1.113883.6.96 (SNOMED CT) |
| |
Voorbeeld |
<code code="52981000146104" codeSystem="2.16.840.1.113883.6.96" codeSystemName="SNOMED CT" displayName="Medication section (record artifact)"/> |
hl7:title
|
ST |
1 … 1 |
M |
Dit attribuut is verplicht te gebruiken om het document type te verduidelijken. Hierbij
is het mogelijk om bijvoorbeeld de auteur en/of patiënt naam, datum van het overdracht
te vermelden |
|
| |
Voorbeeld |
<title>Medicatiegegevens van Maria Bakker 2 juni 2016</title> |
hl7:effectiveTime
|
TS.DATETIME.MIN |
1 … 1 |
M |
Bevat de datum waarop het document compleet is. |
|
| |
Voorbeeld |
<effectiveTime value="20160602140500"/> |
hl7:confidentialityCode
|
CE |
1 … 1 |
R |
Mate van vertrouwelijkheid van het document.
N - normal
R - restricted
V - very restricted |
|
| |
CONF |
| @codeSystem moet "2.16.840.1.113883.5.25" zijn |
| of |
| @code moet "N" zijn |
| of |
| @code moet "R" zijn |
| of |
| @code moet "V" zijn |
|
| |
Voorbeeld |
<confidentialityCode code="N" codeSystem="2.16.840.1.113883.5.25"/> |
hl7:languageCode
|
CS.LANG |
1 … 1 |
M |
De taal van het document. Het formaat van dit atribuut is als volgt: 'ss-CC'. 'ss'
staat voor de spraakcode, conform ISO-639-1 en 'CC' voor landencode, conform ISO-3166 |
|
| |
Voorbeeld |
<languageCode code="nl-NL"/> |
| Inclusie |
1 … 1 |
M |
van 2.16.840.1.113883.2.4.3.11.60.3.10.1 CDA recordTarget SDTC NL (2021‑07‑01)
Patiënt |
hl7:recordTarget
|
|
1 … 1 |
M |
|
|
| |
|
hl7:patientRole
|
|
1 … 1 |
R |
|
|
| |
|
hl7:id
|
II |
1 … * |
R |
Patiëntidentificatie. In de meeste gevallen zal dit een Burgerservicenummer zijn (@root
= 2.16.840.1.113883.2.4.6.3). Burgerservicenummers mogen alleen worden doorgegeven
als deze zijn geverifieerd of verkregen uit een betrouwbare bron - Zie de Wet Bsn-z
voor details. In sommige scenario's kunnen ook andere identificaties worden gebruikt,
of kan een identificatie ontbreken (acute zorg als identificatie niet geverifieerd
kan worden, volksgezondheid als identificatie gemaskeerd moet worden, etc.). In die
gevallen is een zo relevant mogelijke reden voor ontbreken via @nullFlavor verplicht |
|
| |
|
@root
|
uid |
0 … 1 |
|
Identificatie van het systeem waaruit de waarde @extension komt. Voor burgerservicenummers
is dat '2.16.840.1.113883.2.4.6.3'. |
@extension
|
st |
0 … 1 |
|
Identificatienummer of -string, bijvoorbeeld het burgerservicenummer |
@nullFlavor
|
cs |
0 … 1 |
|
De meest algemene reden voor afwezigheid is "NI" (No Information). Meer voor de hand
liggen echter "UNK" (onbekend wat het is, maar bekend dat het er is) en "MSK" (gemaskeerd) |
| |
Voorbeeld |
Burgerservicenummer <id extension="100197243" root="2.16.840.1.113883.2.4.6.3"/> |
| |
Voorbeeld |
Identificatie (nog) niet bekend <id nullFlavor="UNK"/> |
| |
Voorbeeld |
Identificatie gemaskeerd <id nullFlavor="MSK"/> |
hl7:addr
|
AD.NL |
0 … * |
R |
|
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'tel:')] |
|
| |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'mailto:')] |
|
| |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
hl7:patient
|
|
0 … 1 |
|
|
|
hl7:name
|
PN.NL |
1 … * |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
Voorbeeld |
<name nullFlavor="MSK"/> |
| 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:prefix[@qualifier='NB']
- hl7:given[@qualifier='BR']
- hl7:given[@qualifier='CL']
- hl7:given[@qualifier='IN']
- hl7:given[not(@qualifier)]
- hl7:prefix[.[not(@qualifier)] | .[tokenize(@qualifier,'\s')='VV'][not(tokenize(@qualifier,'\s')=('BR',
'SP'))][following-sibling::hl7:family[1][not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]]
- hl7:family[not(tokenize(@qualifier,'\s')=('BR', 'SP'))]
- 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:prefix
|
ENXP |
0 … 1 |
|
Adellijke titel. Een titel (meestal voluit geschreven) die is ontleend aan iemands
aristocratische status. Voorbeelden zijn "Jonkheer ", "Graaf ", etc. Noot 1: zie ook
GBA Tabel 38 Adellijke titel/predicaat. Noot 2: Adellijke titels spelen normaal geen
rol van betekenis in de zorg en ondersteuning hiervoor kan variëren van systeem tot
systeem. De zorginformatiebouwstenen tot in elk geval release 2020 bieden geen handvat
voor adellijke titels. |
|
| waar [@qualifier='NB'] |
|
@qualifier
|
set_cs |
1 … 1 |
F |
NB |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="NB">Jonkheer </prefix> |
hl7:given
|
ENXP |
0 … 1 |
R |
Bevat de voornamen van een persoon. De qualifier 'BR' duidt een officiële voornaam
aan |
|
| 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 |
R |
Bevat de roepnaam van een persoon. De qualifier 'CL' duidt een roepnaam aan |
|
| 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 |
R |
Bevat de voorletters van een persoon. Een afsluitende punt moet expliciet worden vermeld.
De qualifier heeft de waarde "IN" voor de initialen |
|
| 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. |
|
| waar [not(@qualifier)] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Prefixdeel van ongedefinieerd type, of van alleen type voorvoegsel (VV) gevolgd door
een achternaam zonder type BR (geboortenaam) of SP (partnernaam). Als van een achternaamdeel
het type BR of SP te duiden is, dan zou dat bij het voorvoegsel ook moeten kunnen.
Element prefix bij voorkeur alleen met volledig type gebruiken. |
|
waar [. [not(@qualifier)] of
[tokenize(@qualifier,'\s')='VV'] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] [following-sibling::hl7:family
[1] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]] |
|
| |
|
hl7:family
|
ENXP |
0 … 1 |
R |
Achternaamdeel van ongedefinieerd type dus zonder BR of SP. Bij voorkeur alleen met
type gebruiken. |
|
| waar [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam en moet direct voorafgaand aan de geslachtsnaam
in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='BR']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV BR" of "BR VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van der </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam van een persoon. Het qualifier 'BR' duidt een geslachtsnaam
aan |
|
| 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". |
|
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam van partner en moet direct voorafgaand aan
de geslachtsnaam partner in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='SP']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV SP" of "SP VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam partner van een persoon. Het qualifier type 'SP' duidt een
geslachtsnaam partner aan |
|
| 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". |
|
@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). |
|
| |
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 |
 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 |
0 … 1 |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
CONF |
|
| |
Voorbeeld |
<administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/> |
| |
Voorbeeld |
<administrativeGenderCode nullFlavor="MSK"/> |
hl7:birthTime
|
TS |
0 … 1 |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
Voorbeeld |
<birthTime value="19320924"/> |
| |
Voorbeeld |
<birthTime nullFlavor="MSK"/> |
sdtc:deceasedInd
|
BL |
0 … 1 |
R |
|
|
sdtc:deceasedTime
|
TS |
0 … 1 |
|
|
|
sdtc:multipleBirthInd
|
BL |
0 … 1 |
|
|
|
| |
|
hl7:maritalStatusCode
|
CE |
0 … 1 |
|
|
|
| |
CONF |
|
hl7:guardian
|
|
0 … * |
|
|
|
@classCode
|
cs |
0 … 1 |
F |
GUARD |
hl7:code
|
CE |
0 … 1 |
|
|
|
| |
CONF |
|
hl7:addr
|
AD.NL |
0 … * |
|
|
|
| |
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'tel:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'mailto:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
| Keuze |
1 … 1 |
|
Elementen om uit te kiezen:
|
hl7:guardianPerson
|
|
0 … 1 |
|
|
|
hl7:name
|
PN.NL |
0 … 1 |
|
|
|
| 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:prefix[@qualifier='NB']
- hl7:given[@qualifier='BR']
- hl7:given[@qualifier='CL']
- hl7:given[@qualifier='IN']
- hl7:given[not(@qualifier)]
- hl7:prefix[.[not(@qualifier)] | .[tokenize(@qualifier,'\s')='VV'][not(tokenize(@qualifier,'\s')=('BR',
'SP'))][following-sibling::hl7:family[1][not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]]
- hl7:family[not(tokenize(@qualifier,'\s')=('BR', 'SP'))]
- 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:prefix
|
ENXP |
0 … 1 |
|
Adellijke titel. Een titel (meestal voluit geschreven) die is ontleend aan iemands
aristocratische status. Voorbeelden zijn "Jonkheer ", "Graaf ", etc. Noot 1: zie ook
GBA Tabel 38 Adellijke titel/predicaat. Noot 2: Adellijke titels spelen normaal geen
rol van betekenis in de zorg en ondersteuning hiervoor kan variëren van systeem tot
systeem. De zorginformatiebouwstenen tot in elk geval release 2020 bieden geen handvat
voor adellijke titels. |
|
| waar [@qualifier='NB'] |
|
@qualifier
|
set_cs |
1 … 1 |
F |
NB |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="NB">Jonkheer </prefix> |
hl7:given
|
ENXP |
0 … 1 |
R |
Bevat de voornamen van een persoon. De qualifier 'BR' duidt een officiële voornaam
aan |
|
| 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 |
R |
Bevat de roepnaam van een persoon. De qualifier 'CL' duidt een roepnaam aan |
|
| 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 |
R |
Bevat de voorletters van een persoon. Een afsluitende punt moet expliciet worden vermeld.
De qualifier heeft de waarde "IN" voor de initialen |
|
| 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. |
|
| waar [not(@qualifier)] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Prefixdeel van ongedefinieerd type, of van alleen type voorvoegsel (VV) gevolgd door
een achternaam zonder type BR (geboortenaam) of SP (partnernaam). Als van een achternaamdeel
het type BR of SP te duiden is, dan zou dat bij het voorvoegsel ook moeten kunnen.
Element prefix bij voorkeur alleen met volledig type gebruiken. |
|
waar [. [not(@qualifier)] of
[tokenize(@qualifier,'\s')='VV'] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] [following-sibling::hl7:family
[1] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]] |
|
| |
|
hl7:family
|
ENXP |
0 … 1 |
R |
Achternaamdeel van ongedefinieerd type dus zonder BR of SP. Bij voorkeur alleen met
type gebruiken. |
|
| waar [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam en moet direct voorafgaand aan de geslachtsnaam
in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='BR']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV BR" of "BR VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van der </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam van een persoon. Het qualifier 'BR' duidt een geslachtsnaam
aan |
|
| 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". |
|
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam van partner en moet direct voorafgaand aan
de geslachtsnaam partner in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='SP']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV SP" of "SP VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam partner van een persoon. Het qualifier type 'SP' duidt een
geslachtsnaam partner aan |
|
| 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". |
|
@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). |
|
| |
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 |
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 |
|
sdtc:asPatientRelationship
|
|
0 … 1 |
|
|
|
@classCode
|
cs |
1 … 1 |
F |
PRS |
sdtc:code
|
CE |
1 … 1 |
R |
|
|
| |
CONF |
|
| Inclusie |
1 … * |
R |
van 2.16.840.1.113883.2.4.3.11.60.121.10.39 CDA author SDTC NL (2021‑07‑01) |
hl7:author
|
|
1 … * |
R |
|
|
@typeCode
|
cs |
0 … 1 |
F |
AUT |
@contextControlCode
|
cs |
0 … 1 |
F |
OP |
hl7:functionCode
|
CE |
0 … 1 |
|
|
|
| |
CONF |
|
hl7:time
|
TS |
1 … 1 |
R |
Afrondingsdatum bijdrage van de auteur aan het document, of @nullFlavor=NI indien
onbekend. Als er één auteur aan het document heeft gewerkt, dan zal de waarde in author.time
naar verwachting overeenkomen met ClinicalDocument.effectiveTime |
|
| |
|
| Keuze |
1 … 1 |
|
Elementen om uit te kiezen:
- hl7:assignedAuthor[not(hl7:code/@code = 'ONESELF')]
- hl7:assignedAuthor[hl7:code/@code = 'ONESELF']
|
hl7:assignedAuthor
|
|
0 … 1 |
R |
Auteur is zorgverlener of apparaat (voor automatisch gegenereerde documenten) |
|
| waar [not(hl7:code/@code = 'ONESELF')] |
|
@classCode
|
cs |
0 … 1 |
F |
ASSIGNED |
| Inclusie |
1 … * |
R |
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.30 zorgverleneridentificatienummer (DYNAMISCH)
Vul met nullFlavor 'NI' als er geen identificatie van de auteur bekend is. |
| Keuze |
1 … * |
|
Elementen om uit te kiezen:
- hl7:id[@root = '2.16.528.1.1007.3.1']
- hl7:id[@root = '2.16.840.1.113883.2.4.6.1']
- hl7:id[@root = '2.16.528.1.1007.5.1']
- hl7:id[not(@root = ('2.16.528.1.1007.3.1', '2.16.840.1.113883.2.4.6.1', '2.16.528.1.1007.5.1'))]
|
hl7:id
|
II.NL.UZI |
0 … 1 |
R |
Identificerend nummer van zorgverlener met bijbehorend codesysteem (UZI nummer natuurlijke
personen) |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.528.1.1007.3.1 |
| |
2.16.528.1.1007.3.1 is de OID van Zorgverlener UZI |
@extension
|
st |
1 … 1 |
R |
|
| |
Voorbeeld |
<id root="2.16.528.1.1007.3.1" extension="129854656"/> |
hl7:id
|
II.NL.AGB |
0 … 1 |
R |
Identificerend nummer van zorgverlener met bijbehorend codesysteem (Vektis AGB-zorgverlener
tabel) |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.6.1 |
| |
2.16.840.1.113883.2.4.6.1 is de OID van Vektis AGB‐Z |
@extension
|
st |
1 … 1 |
R |
|
| |
Voorbeeld |
<id root="2.16.840.1.113883.2.4.6.1" extension="129854656"/> |
hl7:id
|
II.NL.BIG |
0 … 1 |
R |
Identificerend nummer van zorgverlener met bijbehorend codesysteem (BIG register inschrijvingsnummer) |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.528.1.1007.5.1 |
| |
2.16.528.1.1007.5.1 is de OID van BIG Register |
@extension
|
st |
1 … 1 |
R |
|
| |
Voorbeeld |
<id root="2.16.528.1.1007.5.1" extension="129854656"/> |
hl7:id
|
II |
0 … 1 |
R |
Zorgverleneridentificatienummer anders dan UZI, AGB of BIG. Bij een id (attribuut
@extension) hoort een identificatiesysteem (attribuut @root) in de vorm van een OID.
In het geval er geen OID bekend is, kan in plaats van een OID in @root, het attribuut
@nullFlavor met waarde UNC worden gebruikt. Het verdient de voorkeur om expliciet
te maken wat het identificatiesysteem is en de situatie met @nullFlavor=UNC zou dan
ook bij voorkeur tijdelijk moeten zijn. |
|
| waar [not(@root = ('2.16.528.1.1007.3.1', '2.16.840.1.113883.2.4.6.1', '2.16.528.1.1007.5.1'))] |
|
| |
|
| |
Voorbeeld |
ID 12345 uit identificatiesysteem 1.2.3.4.9999 <id root="1.2.3.4.9999" extension="12345"/> |
| |
Voorbeeld |
ID 12345 uit (nog) onbekend identificatiesysteem <id nullFlavor="UNC" extension="12345"/> |
hl7:code
|
CE |
0 … 1 |
|
Bevat het specialisme van de zorgverlener |
|
| |
CONF |
|
hl7:addr
|
AD.NL |
0 … 1 |
|
Bevat adres |
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
Bevat telefoonnummer |
|
| waar [starts-with(@value,'tel:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
Bevat e-mailadres |
|
| waar [starts-with(@value,'mailto:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
| Keuze |
0 … 1 |
|
Elementen om uit te kiezen:
|
hl7:assignedPerson
|
|
|
|
Bevat 2.16.840.1.113883.2.4.3.11.60.3.10.0.4 person (2018‑06‑11) |
|
hl7:assignedAuthoringDevice
|
|
|
|
Bevat 2.16.840.1.113883.10.12.815 CDA Device SDTC (DYNAMISCH) |
|
| Inclusie |
0 … 1 |
|
van 2.16.840.1.113883.2.4.3.11.60.121.10.33 uitvoerende zorgaanbieder (2021‑07‑01) |
hl7:representedOrganization
|
|
0 … 1 |
|
Bevat gegevens over de zorgaanbiederorganisatie |
|
| |
|
@classCode
|
cs |
0 … 1 |
F |
ORG |
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.7.10.53 zorgaanbiederidentificatienummer (2019‑04‑07 14:36:08) |
| Keuze |
0 … * |
|
Elementen om uit te kiezen:
- hl7:id[@root = '2.16.528.1.1007.3.3']
- hl7:id[@root = '2.16.840.1.113883.2.4.6.1']
- hl7:id[@root = '2.16.840.1.113883.2.4.6.8']
- hl7:id[not(@root = ('2.16.528.1.1007.3.3', '2.16.840.1.113883.2.4.6.1', '2.16.840.1.113883.2.4.6.8'))]
|
hl7:id
|
II.NL.URA |
0 … 1 |
R |
Zorgaanbiederidentificatienummer: UZI Registerabonneenummer (URA). Element bevat @root
en @extension. |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.528.1.1007.3.3 |
| |
OID van het CIBG UZI‐Register‐Abonneenummer |
@extension
|
st |
1 … 1 |
R |
URA (het CIBG UZI‐Register‐Abonneenummer) |
hl7:id
|
II.NL.AGB |
0 … 1 |
R |
Zorgaanbiederidentificatienummer: De Vektis AGB-Z Zorgaanbieder identificatie. Element
bevat @root en @extension. |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.6.1 |
| |
OID van de Vektis AGB-Z Zorgaanbieder identificatie |
@extension
|
st |
1 … 1 |
R |
AGB code |
hl7:id
|
II |
0 … 1 |
R |
Zorgaanbiederidentificatienummer: De Vektis RAV / ambulanceorganisatie ID. Element
bevat @root en @extension. |
|
| |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.6.8 |
| |
OID van de Vektis RAV / ambulanceorganisatie ID |
@extension
|
st |
1 … 1 |
R |
RAV / ambulanceorganisatie id |
hl7:id
|
II |
0 … * |
R |
Zorgaanbiederidentificatienummer anders dan URA, AGB, Vektis RAV ID. Bij een id (attribuut
@extension) hoort een identificatiesysteem (attribuut @root) in de vorm van een OID.
In het geval er geen OID bekend is, kan in plaats van een OID in @root, het attribuut
@nullFlavor met waarde UNC worden gebruikt. Het verdient de voorkeur om expliciet
te maken wat het identificatiesysteem is en de situatie met @nullFlavor=UNC zou dan
ook bij voorkeur tijdelijk moeten zijn. |
|
| waar [not(@root = ('2.16.528.1.1007.3.3', '2.16.840.1.113883.2.4.6.1', '2.16.840.1.113883.2.4.6.8'))] |
|
| |
|
hl7:name
|
ON |
0 … 1 |
|
Naam van zorgaanbieder of locatie van de zorgaanbieder |
|
| |
|
| |
Voorbeeld |
<name>Ziekenhuis St. Nicolas</name> |
| |
Voorbeeld |
<name>Locatie Kerklaan</name> |
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
Telefoon van zorgaanbieder |
|
| waar [starts-with(@value,'tel:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
E-mailadres van zorgaanbieder |
|
| waar [starts-with(@value,'mailto:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
hl7:addr
|
AD.NL |
0 … * |
|
|
|
| |
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:standardIndustryClassCode
|
CE (extensible) |
0 … 1 |
|
Bevat code die het type van een zorgaanbieder bepaalt |
|
| |
|
| |
CONF |
|
| |
Voorbeeld |
<standardIndustryClassCode code="V4" codeSystem="2.16.840.1.113883.2.4.15.1060" displayName="Ziekenhuis"/> |
hl7:asOrganizationPartOf
|
|
0 … 1 |
|
Bevat afdelingsspecialisme. De afdeling maakt deel uit zorgaanbieder organisatie |
|
| |
Voorbeeld |
<asOrganizationPartOf>
<code code="0303" codeSystem="2.16.840.1.113883.2.4.6.7" displayName="Chirurgie"/> <!-- COD016-VEKT (Vektis AGB-medische specialismen) -->
</asOrganizationPartOf> |
hl7:code
|
CE |
0 … 1 |
|
|
|
| |
|
| |
CONF |
|
hl7:wholeOrganization
|
|
0 … 1 |
|
Als deze representedOrganization een locatie van een zorgaanbieder is, dan komen hier
de gegevens van de overkoepelende organisatie. |
|
hl7:name
|
ON |
0 … 1 |
|
Naam van overkoepelende zorgaanbieder |
|
| |
Voorbeeld |
<name>Ziekenhuis St. Nicolas</name> |
hl7:assignedAuthor
|
|
0 … 1 |
R |
Auteur is patiënt. De ClinicalDocument.recordTarget met hetzelfde id bevat (mogelijk)
meer volledige gegevens. |
|
| waar [hl7:code/@code = 'ONESELF'] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.7.10.52 CDA author of informant patient (2017‑08‑25) |
@classCode
|
cs |
0 … 1 |
F |
ASSIGNED |
| Keuze |
1 … * |
|
Elementen om uit te kiezen:
- hl7:id[@root='2.16.840.1.113883.2.4.6.3']
- hl7:id[not(@root='2.16.840.1.113883.2.4.6.3')]
- hl7:id[@nullFlavor]
|
hl7:id
|
II.NL.BSN |
0 … 1 |
R |
BSN. Een BSN is N8..9 maar is in berichten altijd N9, eventueel via een voorloopnul. |
|
| waar [@root='2.16.840.1.113883.2.4.6.3'] |
|
hl7:id
|
II |
0 … 1 |
R |
Andere identificatie |
|
| waar [not(@root='2.16.840.1.113883.2.4.6.3')] |
|
@root
|
cs |
1 … 1 |
R |
|
@extension
|
cs |
1 … 1 |
R |
|
hl7:id
|
II |
0 … 1 |
R |
|
|
| waar [@nullFlavor] |
|
@nullFlavor
|
cs |
1 … 1 |
R |
Gebruik nullFlavor 'MSK' voor een gemaskeerde identificatie |
hl7:code
|
CE |
1 … 1 |
M |
|
|
@code
|
CONF |
1 … 1 |
F |
ONESELF |
@codeSystem
|
1 … 1 |
F |
2.16.840.1.113883.5.111 (RoleCode) |
| Inclusie |
1 … 1 |
R |
van 2.16.840.1.113883.2.4.3.11.60.121.10.15 CDA custodian SDTC NL (2021‑07‑01) |
hl7:custodian
|
|
1 … 1 |
R |
|
|
@typeCode
|
cs |
0 … 1 |
F |
CST |
hl7:assignedCustodian
|
|
1 … 1 |
R |
|
|
@classCode
|
cs |
0 … 1 |
F |
ASSIGNED |
hl7:representedCustodianOrganization
|
|
1 … 1 |
R |
|
|
@classCode
|
cs |
0 … 1 |
F |
ORG |
@determinerCode
|
cs |
0 … 1 |
F |
INSTANCE |
| Keuze |
1 … * |
|
Elementen om uit te kiezen:
- hl7:id[@root = '2.16.528.1.1007.3.3']
- hl7:id[@root = '2.16.840.1.113883.2.4.6.1']
- hl7:id[@root = '2.16.840.1.113883.2.4.6.8']
- hl7:id[@root[not(. = ('2.16.528.1.1007.3.3', '2.16.840.1.113883.2.4.6.1', '2.16.840.1.113883.2.4.6.8'))]]
|
hl7:id
|
II.NL.URA |
0 … 1 |
R |
Identificerend nummer van de organisatie: UZI Registerabonneenummer (URA). Element
bevat @root en @extension. |
|
@root
|
uid |
1 … 1 |
F |
2.16.528.1.1007.3.3 |
| |
OID van het CIBG UZI‐Register‐Abonneenummer |
@extension
|
st |
1 … 1 |
R |
URA (het CIBG UZI‐Register‐Abonneenummer) |
hl7:id
|
II.NL.AGB |
0 … 1 |
R |
Identificerend nummer van de organisatie: De Vektis AGB-Z Zorgaanbieder identificatie.
Element bevat @root en @extension. |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.6.1 |
| |
OID van de Vektis AGB-Z Zorgaanbieder identificatie |
@extension
|
st |
1 … 1 |
R |
AGB code |
hl7:id
|
II |
0 … 1 |
R |
Identificerend nummer van de organisatie: De Vektis RAV / ambulanceorganisatie ID.
Element bevat @root en @extension. |
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.6.8 |
| |
OID van de Vektis RAV / ambulanceorganisatie ID |
@extension
|
st |
1 … 1 |
R |
RAV / ambulanceorganisatie id |
hl7:id
|
II |
0 … * |
R |
Identificerend nummer van de organisatie anders dan URA of AGB of Vektis RAV. |
|
| waar [@root [not(. = ('2.16.528.1.1007.3.3', '2.16.840.1.113883.2.4.6.1', '2.16.840.1.113883.2.4.6.8'))]] |
|
hl7:name
|
ON |
0 … 1 |
|
Naam van organisatie |
|
| |
Voorbeeld |
<name>Ziekenhuis St. Nicolas</name> |
hl7:telecom
|
TEL.NL.EXTENDED |
0 … 1 |
|
Telefoon, fax, e-mailadres. In het schema wordt slechts één van deze waarden toegestaan |
|
hl7:addr
|
AD.NL |
0 … 1 |
|
|
|
hl7:component
|
|
|
|
|
|
hl7:structuredBody
|
|
|
|
|
|
| |
|
hl7:component
|
|
1 … 1 |
R |
|
|
hl7:section
|
|
1 … 1 |
R |
|
|
hl7:text
|
|
0 … 1 |
|
|
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9430 MP CDA Medicatieafspraak (2022‑11‑22 13:24:32) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9449 MP CDA Verstrekkingsverzoek (2023‑01‑06 09:30:41) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9416 MP CDA Toedieningsafspraak (2022‑11‑21 07:47:58) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9364 MP CDA Verstrekking (2021‑06‑02 16:19:35) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9444 MP CDA Medicatiegebruik (2022‑11‑24 15:47:10) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9406 MP CDA Medicatietoediening (2022‑11‑01 09:17:30) |
|
hl7:entry
|
|
0 … * |
R |
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9412 MP CDA Wisselend doseerschema (2022‑11‑18 13:09:22) |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.20.77.10.9411 MP HL7 Medicatiegegevens Organizer (2022‑11‑18 09:12:39)
organizer |
hl7:organizer
|
|
1 … 1 |
M |
|
|
| |
|
@classCode
|
cs |
1 … 1 |
F |
CLUSTER |
@moodCode
|
cs |
1 … 1 |
F |
EVN |
hl7:templateId
|
II |
1 … 1 |
M |
|
|
@root
|
uid |
1 … 1 |
F |
2.16.840.1.113883.2.4.3.11.60.20.77.10.9411 |
hl7:code
|
|
1 … 1 |
R |
|
|
@code
|
|
1 … 1 |
F |
102 |
@displayName
|
|
0 … 1 |
|
Medicatiegegevens |
@codeSystem
|
|
1 … 1 |
F |
2.16.840.1.113883.2.4.3.11.60.20.77.4 |
@codeSystemName
|
|
0 … 1 |
|
Medicatieproces transacties |
hl7:statusCode
|
|
1 … 1 |
R |
|
|
@code
|
cs |
0 … 1 |
|
|
| |
CONF |
|
@nullFlavor
|
cs |
0 … 1 |
|
NI |
| |
Voorbeeld |
<statusCode nullFlavor="NI"/> |
| |
Voorbeeld |
<statusCode code="completed"/> |
| Inclusie |
1 … 1 |
M |
van 2.16.840.1.113883.2.4.3.11.60.3.10.1 CDA recordTarget SDTC NL (2021‑07‑01)
Patiënt |
hl7:recordTarget
|
|
1 … 1 |
M |
|
|
| |
|
hl7:patientRole
|
|
1 … 1 |
R |
|
|
| |
|
hl7:id
|
II |
1 … * |
R |
Patiëntidentificatie. In de meeste gevallen zal dit een Burgerservicenummer zijn (@root
= 2.16.840.1.113883.2.4.6.3). Burgerservicenummers mogen alleen worden doorgegeven
als deze zijn geverifieerd of verkregen uit een betrouwbare bron - Zie de Wet Bsn-z
voor details. In sommige scenario's kunnen ook andere identificaties worden gebruikt,
of kan een identificatie ontbreken (acute zorg als identificatie niet geverifieerd
kan worden, volksgezondheid als identificatie gemaskeerd moet worden, etc.). In die
gevallen is een zo relevant mogelijke reden voor ontbreken via @nullFlavor verplicht |
|
| |
|
@root
|
uid |
0 … 1 |
|
Identificatie van het systeem waaruit de waarde @extension komt. Voor burgerservicenummers
is dat '2.16.840.1.113883.2.4.6.3'. |
@extension
|
st |
0 … 1 |
|
Identificatienummer of -string, bijvoorbeeld het burgerservicenummer |
@nullFlavor
|
cs |
0 … 1 |
|
De meest algemene reden voor afwezigheid is "NI" (No Information). Meer voor de hand
liggen echter "UNK" (onbekend wat het is, maar bekend dat het er is) en "MSK" (gemaskeerd) |
| |
Voorbeeld |
Burgerservicenummer <id extension="100197243" root="2.16.840.1.113883.2.4.6.3"/> |
| |
Voorbeeld |
Identificatie (nog) niet bekend <id nullFlavor="UNK"/> |
| |
Voorbeeld |
Identificatie gemaskeerd <id nullFlavor="MSK"/> |
hl7:addr
|
AD.NL |
0 … * |
R |
|
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'tel:')] |
|
| |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'mailto:')] |
|
| |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
hl7:patient
|
|
0 … 1 |
|
|
|
hl7:name
|
PN.NL |
1 … * |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
Voorbeeld |
<name nullFlavor="MSK"/> |
| 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:prefix[@qualifier='NB']
- hl7:given[@qualifier='BR']
- hl7:given[@qualifier='CL']
- hl7:given[@qualifier='IN']
- hl7:given[not(@qualifier)]
- hl7:prefix[.[not(@qualifier)] | .[tokenize(@qualifier,'\s')='VV'][not(tokenize(@qualifier,'\s')=('BR',
'SP'))][following-sibling::hl7:family[1][not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]]
- hl7:family[not(tokenize(@qualifier,'\s')=('BR', 'SP'))]
- 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:prefix
|
ENXP |
0 … 1 |
|
Adellijke titel. Een titel (meestal voluit geschreven) die is ontleend aan iemands
aristocratische status. Voorbeelden zijn "Jonkheer ", "Graaf ", etc. Noot 1: zie ook
GBA Tabel 38 Adellijke titel/predicaat. Noot 2: Adellijke titels spelen normaal geen
rol van betekenis in de zorg en ondersteuning hiervoor kan variëren van systeem tot
systeem. De zorginformatiebouwstenen tot in elk geval release 2020 bieden geen handvat
voor adellijke titels. |
|
| waar [@qualifier='NB'] |
|
@qualifier
|
set_cs |
1 … 1 |
F |
NB |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="NB">Jonkheer </prefix> |
hl7:given
|
ENXP |
0 … 1 |
R |
Bevat de voornamen van een persoon. De qualifier 'BR' duidt een officiële voornaam
aan |
|
| 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 |
R |
Bevat de roepnaam van een persoon. De qualifier 'CL' duidt een roepnaam aan |
|
| 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 |
R |
Bevat de voorletters van een persoon. Een afsluitende punt moet expliciet worden vermeld.
De qualifier heeft de waarde "IN" voor de initialen |
|
| 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. |
|
| waar [not(@qualifier)] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Prefixdeel van ongedefinieerd type, of van alleen type voorvoegsel (VV) gevolgd door
een achternaam zonder type BR (geboortenaam) of SP (partnernaam). Als van een achternaamdeel
het type BR of SP te duiden is, dan zou dat bij het voorvoegsel ook moeten kunnen.
Element prefix bij voorkeur alleen met volledig type gebruiken. |
|
waar [. [not(@qualifier)] of
[tokenize(@qualifier,'\s')='VV'] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] [following-sibling::hl7:family
[1] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]] |
|
| |
|
hl7:family
|
ENXP |
0 … 1 |
R |
Achternaamdeel van ongedefinieerd type dus zonder BR of SP. Bij voorkeur alleen met
type gebruiken. |
|
| waar [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam en moet direct voorafgaand aan de geslachtsnaam
in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='BR']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV BR" of "BR VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van der </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam van een persoon. Het qualifier 'BR' duidt een geslachtsnaam
aan |
|
| 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". |
|
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam van partner en moet direct voorafgaand aan
de geslachtsnaam partner in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='SP']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV SP" of "SP VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam partner van een persoon. Het qualifier type 'SP' duidt een
geslachtsnaam partner aan |
|
| 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". |
|
@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). |
|
| |
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 |
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 |
0 … 1 |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
CONF |
|
| |
Voorbeeld |
<administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/> |
| |
Voorbeeld |
<administrativeGenderCode nullFlavor="MSK"/> |
hl7:birthTime
|
TS |
0 … 1 |
R |
|
|
| |
|
@nullFlavor
|
cs |
0 … 1 |
|
Wanneer er geen reden en/of grondslag voor uitwisseling is, wordt "MSK" (gemaskeerd)
gebruikt. Er kan ook "NI" (No Information) of "UNK" (onbekend, maar bekend dat het
er is) gebruikt worden. |
| |
Voorbeeld |
<birthTime value="19320924"/> |
| |
Voorbeeld |
<birthTime nullFlavor="MSK"/> |
sdtc:deceasedInd
|
BL |
0 … 1 |
R |
|
|
sdtc:deceasedTime
|
TS |
0 … 1 |
|
|
|
sdtc:multipleBirthInd
|
BL |
0 … 1 |
|
|
|
| |
|
hl7:maritalStatusCode
|
CE |
0 … 1 |
|
|
|
| |
CONF |
|
hl7:guardian
|
|
0 … * |
|
|
|
@classCode
|
cs |
0 … 1 |
F |
GUARD |
hl7:code
|
CE |
0 … 1 |
|
|
|
| |
CONF |
|
hl7:addr
|
AD.NL |
0 … * |
|
|
|
| |
|
| 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 |
|
| |
|
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. |
|
| |
|
| |
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. |
|
| |
|
| |
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.
|
|
| |
|
| |
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. |
|
| |
|
| |
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. |
|
| |
|
@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. |
|
| |
|
hl7:city
|
ST |
0 … 1 |
R |
Plaats |
|
| |
|
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. |
|
| |
|
@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. |
|
| |
|
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.
|
|
| |
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:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'tel:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.103 phone number - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
Dit attribuut is een spatie gescheiden lijst van kenmerken. Het kan twee van de kenmerken
uit het zib element TelecomType bevatten (MC or PG) en een of meer van de kenmerken
uit het element NummerSoort. |
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
Telefoonnummers bestaan uit een uri beginnend met tel:. Faxnummers bestaan uit een
uri beginnend fax:. Let op: een uri bevat bijvoorbeeld geen spaties. |
| |
|
hl7:telecom
|
TEL.NL.EXTENDED |
0 … * |
|
|
|
| waar [starts-with(@value,'mailto:')] |
|
| Inclusie |
|
|
van 2.16.840.1.113883.2.4.3.11.60.3.10.1.104 email address - generic (2018‑06‑11) |
@use
|
set_cs |
0 … 1 |
|
|
| |
CONF |
|
| |
|
@value
|
url |
1 … 1 |
R |
E-mailadressen bestaan uit een uri beginnend met mailto:. Let op: een uri bevat bijvoorbeeld
geen spaties. |
| |
|
| Keuze |
1 … 1 |
|
Elementen om uit te kiezen:
|
hl7:guardianPerson
|
|
0 … 1 |
|
|
|
hl7:name
|
PN.NL |
0 … 1 |
|
|
|
| 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:prefix[@qualifier='NB']
- hl7:given[@qualifier='BR']
- hl7:given[@qualifier='CL']
- hl7:given[@qualifier='IN']
- hl7:given[not(@qualifier)]
- hl7:prefix[.[not(@qualifier)] | .[tokenize(@qualifier,'\s')='VV'][not(tokenize(@qualifier,'\s')=('BR',
'SP'))][following-sibling::hl7:family[1][not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]]
- hl7:family[not(tokenize(@qualifier,'\s')=('BR', 'SP'))]
- 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:prefix
|
ENXP |
0 … 1 |
|
Adellijke titel. Een titel (meestal voluit geschreven) die is ontleend aan iemands
aristocratische status. Voorbeelden zijn "Jonkheer ", "Graaf ", etc. Noot 1: zie ook
GBA Tabel 38 Adellijke titel/predicaat. Noot 2: Adellijke titels spelen normaal geen
rol van betekenis in de zorg en ondersteuning hiervoor kan variëren van systeem tot
systeem. De zorginformatiebouwstenen tot in elk geval release 2020 bieden geen handvat
voor adellijke titels. |
|
| waar [@qualifier='NB'] |
|
@qualifier
|
set_cs |
1 … 1 |
F |
NB |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="NB">Jonkheer </prefix> |
hl7:given
|
ENXP |
0 … 1 |
R |
Bevat de voornamen van een persoon. De qualifier 'BR' duidt een officiële voornaam
aan |
|
| 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 |
R |
Bevat de roepnaam van een persoon. De qualifier 'CL' duidt een roepnaam aan |
|
| 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 |
R |
Bevat de voorletters van een persoon. Een afsluitende punt moet expliciet worden vermeld.
De qualifier heeft de waarde "IN" voor de initialen |
|
| 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. |
|
| waar [not(@qualifier)] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Prefixdeel van ongedefinieerd type, of van alleen type voorvoegsel (VV) gevolgd door
een achternaam zonder type BR (geboortenaam) of SP (partnernaam). Als van een achternaamdeel
het type BR of SP te duiden is, dan zou dat bij het voorvoegsel ook moeten kunnen.
Element prefix bij voorkeur alleen met volledig type gebruiken. |
|
waar [. [not(@qualifier)] of
[tokenize(@qualifier,'\s')='VV'] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] [following-sibling::hl7:family
[1] [not(tokenize(@qualifier,'\s')=('BR', 'SP'))]]] |
|
| |
|
hl7:family
|
ENXP |
0 … 1 |
R |
Achternaamdeel van ongedefinieerd type dus zonder BR of SP. Bij voorkeur alleen met
type gebruiken. |
|
| waar [not(tokenize(@qualifier,'\s')=('BR', 'SP'))] |
|
| |
|
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam en moet direct voorafgaand aan de geslachtsnaam
in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='BR']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV BR" of "BR VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van der </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam van een persoon. Het qualifier 'BR' duidt een geslachtsnaam
aan |
|
| 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". |
|
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
hl7:prefix
|
ENXP |
0 … 1 |
R |
Bevat voorvoegsels van de geslachtsnaam van partner en moet direct voorafgaand aan
de geslachtsnaam partner in family staan |
|
| waar [tokenize(@qualifier,'\s')='VV'] [following-sibling::hl7:family [1] [@qualifier='SP']] |
|
| |
|
@qualifier
|
set_cs |
1 … 1 |
R |
Waarde "VV", "VV SP" of "SP VV". |
@nullFlavor
|
|
0 |
NP |
NP/niet aanwezig |
| |
Voorbeeld |
<prefix qualifier="VV">van </prefix> |
hl7:family
|
ENXP |
0 … 1 |
R |
Bevat de geslachtsnaam partner van een persoon. Het qualifier type 'SP' duidt een
geslachtsnaam partner aan |
|
| 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". |
|
@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). |
|
| |
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 |
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 |
|
sdtc:asPatientRelationship
|
|
0 … 1 |
|
|
|
@classCode
|
cs |
1 … 1 |
F |
PRS |
sdtc:code
|
CE |
1 … 1 |
R |
|
|
| |
CONF |
|
hl7:component
|
|
0 … * |
R |
Medicatieafspraak
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9430 MP CDA Medicatieafspraak (2022‑11‑22 13:24:32) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Verstrekkingsverzoek
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9449 MP CDA Verstrekkingsverzoek (2023‑01‑06 09:30:41) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Toedieningsafspraak
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9416 MP CDA Toedieningsafspraak (2022‑11‑21 07:47:58) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Medicatieverstrekking
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9364 MP CDA Verstrekking (2021‑06‑02 16:19:35) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Medicatiegebruik
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9444 MP CDA Medicatiegebruik (2022‑11‑24 15:47:10) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Medicatietoediening
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9406 MP CDA Medicatietoediening (2022‑11‑01 09:17:30) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
hl7:component
|
|
0 … * |
R |
Wisselend doseerschema
Bevat 2.16.840.1.113883.2.4.3.11.60.20.77.10.9412 MP CDA Wisselend doseerschema (2022‑11‑18 13:09:22) |
|
@typeCode
|
cs |
1 … 1 |
F |
COMP |
Template Basis Medicatiegegevens
Transactie
Identificatie MP9 2.0.0