Terug naar index  <<  Terug naar templates

 Template  KEZO CDA recordTarget Minimal

Template (intern) 2.16.840.1.113883.2.4.3.11.60.66.10.105 - CDArecordTargetMinimal
Id 2.16.840.1.113883.2.4.3.11.60.66.10.105
Classificatie CDA header level template
Relatie Specialisatie: template 2.16.840.1.113883.10.12.101 (2005‑09‑07)
Adaptatie: template 2.16.840.1.113883.2.4.3.11.60.66.10.101 (2014‑06‑27)
Versie geldig vanaf 2014‑08‑18 status In ontwikkeling
Open/gesloten Open (ook andere dan gedefinieerde elementen zijn toegestaan)
Omschrijving De persoon van wie gegevens zijn opgenomen in het bericht/document, aangeduid met een verplichte BSN en minimaal aanvullende gegevens.
Koppelingen met
Koppelingen met 4 concepten
Id Naam Dataset
kz-dataelement-5 Patiëntgegevens Ketenzorg
kz-dataelement-6 Persoonsidentificatie Ketenzorg
kz-dataelement-14 Geslacht Ketenzorg
kz-dataelement-469 Geboortedatum Ketenzorg
Gebruikt door / Gebruikt
Gebruikt door / Gebruikt 7 templates
Gebruikt door Template-id Naam Versie
2.16.840.1.113883.2.4.3.11.60.66.10.10 VZVZ Opleveren Contactmomenten 2014‑08‑18
2.16.840.1.113883.2.4.3.11.60.66.10.12 VZVZ Opleveren Medicatievoorschriften 2014‑08‑18
2.16.840.1.113883.2.4.3.11.60.66.10.200 KEZO Generieke Groepering 2014‑08‑18
2.16.840.1.113883.2.4.3.11.60.66.10.6 VZVZ Opleveren Labuitslagen 2014‑08‑18
2.16.840.1.113883.2.4.3.11.60.66.10.8 VZVZ Opleveren Algemene Uitslagen 2014‑08‑18
Gebruikt Template-id Naam Versie
2.16.840.1.113883.2.4.3.11.60.101.10.2 Adres 2014‑11‑06
2.16.840.1.113883.2.4.3.11.60.101.10.1 NaamPersoon 2014‑11‑06
Voorbeeld
<recordTarget>
  <patientRole>
    <id extension="100197243" root="2.16.840.1.113883.2.4.6.3"/>
    <!-- .. -->
  </patientRole>
</recordTarget>
Item DT Card Conf Omschrijving Label
hl7:recordTarget
0 .. * (CDArecordTargetMinimal)
treetree @typeCode
0 .. 1 F RCT
treetree @contextControlCode
0 .. 1 F OP
treetree hl7:patientRole
1 .. 1 M (CDArecordTargetMinimal)
treeblank treetree @classCode
0 .. 1 F PAT
target Gekoppeld aan concepten:
kz-dataelement-5 Patiëntgegevens
treeblank treetree hl7:id
II.NL.BSN 1 .. 1 R Patiëntidentificatie (CDArecordTargetMinimal)
treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.6.3
treeblank treeblank treetree @extension
1 .. 1  
  Burgerservicenummer
target Gekoppeld aan concepten:
kz-dataelement-6 Persoonsidentificatie
Ingevoegd van 2.16.840.1.113883.2.4.3.11.60.101.10.2 Adres (2014‑11‑06) 0 .. * Required
treeblank treetree hl7:addr
AD 0 .. * R Adres. Het attribuut @use bevat het soort adres. Sommige elementen hebben datatype SC. Merk op dat in datatype SC de text() node altijd verplicht is, ongeacht of er wordt gecodeerd. Deze kan worden gelezen als de @displayName (CDArecordTargetMinimal)
treeblank treeblank treetree @use
set_cs 0 .. 1  
  De codes voor adrestype worden gedefinieerd door het HL7 domein PostalAddressUse, aangegeven in het “use” attribuut van het element <addr> (zie voorbeelden). Als er geen adrestype bekend is, kan dit attribuut worden weggelaten. Als een adres van meerdere typen is, dan kan het attribuut @use meerdere adrestypen bevatten. Voorbeelden zijn een “tijdelijk bezoekadres” (use=”PHYS TMP”), of een vertrouwelijk bezoek- en postadres (use=”CONF PHYS PST”). Merk op dat de volgorde van de adrestypen er niet toe doet.
  CONF
De waarde van @use moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.23 PostalAddressUseNL (DYNAMISCH)
Keuze min 0 element(en) en max * element(en). Elementen om uit te kiezen:
  • hl7:streetName
  • hl7:houseNumber
  • hl7:buildingNumberSuffix
  • hl7:additionalLocator
  • hl7:postalCode
  • hl7:county
  • hl7:city
  • hl7:country
  • hl7:delimiter
treeblank treeblank treeblank treetree 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. (CDArecordTargetMinimal)
treeblank treeblank treeblank treetree 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 Adres datatype opgenomen. (CDArecordTargetMinimal)
treeblank treeblank treeblank treetree hl7:buildingNumberSuffix
ST 0 .. 1 R Het element buildingNumberSuffix bevat, indien aanwezig, huisletter en/of huisnummertoevoeging.

Export

  • Als er zowel een huisletter als een huisnummertoevoeging bekend is: de huisletter komt eerst, dan een spatie en tenslotte de huisnummertoevoeging. Deze samengestelde waarde wordt doorgegeven in de buildingNumberSuffix.
  • Als er alleen een huisnummertoevoeging bekend is, wordt deze in de buildingNumberSuffix doorgegeven.
  • Als er alleen een huisletter bekend is, wordt deze in de buildingNumberSuffix doorgegeven.

Import

  • Als de buildingNumberSuffix uit één karakter bestaat, dan wordt de waarde als huisletter geïmporteerd.
  • Als de buildingNumberSuffix uit meer dan één karakter bestaat en het tweede karakter is geen spatie, dan wordt de waarde als huisnummertoevoeging geïmporteerd.
  • Als de buildingNumberSuffix uit meer dan één karakter bestaat en het tweede karakter is wel een spatie, dan wordt het gedeelte voor de spatie (het eerste karakter) als huisletter geïmporteerd, en het gedeelte na de spatie (de rest) als huisnummertoevoeging.
(CDArecordTargetMinimal)
treeblank treeblank treeblank treetree hl7:additionalLocator
ST 0 .. 1 R Aanvullende locatie-aanduiding bij het postadres. Dit kan bijvoorbeeld een nummer van een appartement, suite of verdieping zijn. In de Nederlandse situatie wordt dit vaak gebruikt voor de verdieping, bijvoorbeeld ´III´ als het gaat om een woning op 3 hoog. Dit kan ook een aanduiding zijn die de relatie met een ander adres aangeeft zoals ‘to’ (tegenover) of ‘by’ (bij). Als een woonark bijvoorbeeld tegenover nummer 14 ligt, dan wordt ‘14’ in houseNumber gezet en ‘to’ (tegenover) in additionalLocator. (CDArecordTargetMinimal)
CONF
elementinhoud moet "to" zijn
-of-
elementinhoud moet "by" zijn
treeblank treeblank treeblank treetree hl7:postalCode
ST 0 .. 1 R Postcode van het adres. Indien dit een Nederlandse postcode is, dan is het formaat 'nnnn AA' (met spatie) (CDArecordTargetMinimal)
treeblank treeblank treeblank treetree hl7:county
SC 0 .. 1 R In Nederland wordt dit element gebruikt om de gemeente 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 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. (CDArecordTargetMinimal)
CONF
De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.17 Gemeenten (DYNAMISCH)
treeblank treeblank treeblank treetree hl7:city
ST 0 .. 1 R Het element city moet indien aanwezig de woonplaats/postadresplaats bevatten. (CDArecordTargetMinimal)
treeblank treeblank treeblank treetree hl7:country
SC 0 .. 1 C Het element country moet het land bevatten. Indien deze wordt gecodeerd, dan moet worden gecodeerd volgens ISO 3166 Part 1, 2nd Edition, Alpha-2 code (1.0.3166.1.2.2) of GBA tabel 34 (2.16.840.1.113883.2.4.4.16.34). De text() node is in datatype SC altijd verplicht. (CDArecordTargetMinimal)
Constraint Het element mag altijd gevuld worden, maar is verplicht in buitenlandse adressen
CONF
De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.13 Land (DYNAMISCH)
treeblank treeblank treeblank treetree hl7:delimiter
ST 0 .. * Begrenzers (delimiters) worden geprint zonder witte ruimte te vormen (framing). Wanneer er geen waardecomponent wordt geleverd, verschijnt de begrenzer als een regelonderbreking (line break). (CDArecordTargetMinimal)
treeblank treeblank treetree 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.
(CDArecordTargetMinimal)
Constraint In elke situatie waar één of meer adressen worden doorgegeven, moet minimaal het adres worden aangeduid die 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.
treeblank treetree hl7:patient
1 .. 1 R Overige gegevens optioneel (CDArecordTargetMinimal)
treeblank treeblank treetree @classCode
0 .. 1 F PSN
treeblank treeblank treetree @determinerCode
0 .. 1 F INSTANCE
Voorbeeld
<patient classCode="PSN" determinerCode="INSTANCE">
  <name>
    <family qualifier="VV">de </family>
    <family qualifier="BR">Jong</family>
  </name>
  <administrativeGenderCode codeSystem="2.16.840.1.113883.5.1" code="M"/>
  <birthTime value="19670330"/>
</patient>
Ingevoegd van 2.16.840.1.113883.2.4.3.11.60.101.10.1 Naam persoon (2014‑11‑06) 1 .. 1 Required
treeblank treeblank treetree hl7:name
PN 1 .. 1 R (CDArecordTargetMinimal)
treeblank treeblank treeblank treetree @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
  CONF
De waarde van @use moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.18 EntityNameUseNL (DYNAMISCH)
Keuze min 0 element(en) en max * element(en). Elementen om uit te kiezen:
  • hl7:given
  • hl7:prefix
  • hl7:family
  • hl7:suffix
  • hl7:delimiter
Constraint Het is niet toegestaan om lege naamdelen mee te geven. Om aan te geven dat een naamdeel leeg is dient het simpelweg niet te worden meegegeven in het bericht.
treeblank treeblank treeblank treeblank treetree hl7:given
ENXP Bevat voorletter(s) of voorna(a)m(en) van de persoon. Het attribuut qualifier bepaalt wat het is. (CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treeblank treetree @qualifier
set_cs 0 .. 1  
  CONF
De waarde van @qualifier moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.19 NaamDeelGivenQualifier (DYNAMISCH)
treeblank treeblank treeblank treeblank treetree hl7:prefix
ENXP Bevat het voorvoegsel van de geslachtsnaam met de qualifier 'VV' (voorvoegsel), en/of de adellijke titel met qualifier 'NB' Merk op dat de volgorde van de XML tags in het bericht van belang is: de voorvoegsels dienen altijd vóór de bijbehorende family name gecommuniceerd te worden. Merk op dat een voorvoegsel eindigt met een spatie indien het type voorvoegsel dit vereist (wel bij "de" en "van", maar niet bij "l‘".) Eventuele adellijke titels/predikaten worden, voorzien van de qualifier NB, voor de geslachtsnaam opgenomen. (CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treeblank treetree @qualifier
set_cs 0 .. 1  
  CONF
De waarde van @qualifier moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.20 NaamDeelPrefixQualifier (DYNAMISCH)
treeblank treeblank treeblank treeblank treetree hl7:family
ENXP Bevat 1 achternaam met de use qualifier "BR" (geslachtsnaam). (CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treeblank treetree @qualifier
set_cs 0 .. 1  
  CONF
De waarde van @qualifier moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.21 NaamDeelFamilyQualifier (DYNAMISCH)
treeblank treeblank treeblank treeblank treetree hl7:suffix
ENXP 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".

(CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treeblank treetree @qualifier
set_cs 0 .. 1  
  CONF
De waarde van @qualifier moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.101.11.22 NaamDeelSuffixQualifier (DYNAMISCH)
treeblank treeblank treeblank treeblank treetree hl7:delimiter
ENXP 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".
(CDArecordTargetMinimal)
treeblank treeblank treeblank treetree 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).
(CDArecordTargetMinimal)
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.
treeblank treeblank treetree hl7:administrativeGenderCode
CE 1 .. 1 R Geslacht (CDArecordTargetMinimal)
CONF
De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.1.11.1 Administrative Gender (HL7 V3) (DYNAMISCH)
target Gekoppeld aan concepten:
kz-dataelement-14 Geslacht
treeblank treeblank treetree hl7:birthTime
TS 0 .. 1 R Geboortedatum (CDArecordTargetMinimal)
target Gekoppeld aan concepten:
kz-dataelement-469 Geboortedatum
treeblank treeblank treetree hl7:birthplace
0 .. 1 R (CDArecordTargetMinimal)
Voorbeeld
<birthplace>
  <place>
    <addr>
      <city>Breda</city>
      <country>Nederland</country>
    </addr>
  </place>
</birthplace>
treeblank treeblank treeblank treetree hl7:place
1 .. 1 R (CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treetree hl7:addr
AD 1 .. 1 R (CDArecordTargetMinimal)
Keuze min 1 element(en) en max 2 element(en). Elementen om uit te kiezen:
  • hl7:city
  • hl7:country
treeblank treeblank treeblank treeblank treeblank treeblank treetree hl7:city
ST 0 .. 1 R (CDArecordTargetMinimal)
treeblank treeblank treeblank treeblank treeblank treeblank treetree hl7:country
ST 0 .. 1 R (CDArecordTargetMinimal)