Terug naar index  <<  Terug naar templates

active Template  Bericht 1 Opvragen vaccinatiestatus (payload)

Template 2.16.840.1.113883.2.4.6.10.100.181 - OpvragenVaccinatiestatus-payload
Id 2.16.840.1.113883.2.4.6.10.100.181
Versie geldig vanaf 2012‑09‑01 status active Actief
Classificatie HL7v3 Payload level template
Context Parent nodes van template element met id 2.16.840.1.113883.2.4.6.10.100.181
Open/gesloten Open (ook andere dan gedefinieerde elementen zijn toegestaan)
Koppelingen met
Koppelingen met 10 concepten
Id Naam Dataset
jgz-bds-element-7 BSN Basisdataset (BDS) versie 3.2.3
jgz-bds-element-6 Voornaam Basisdataset (BDS) versie 3.2.3
jgz-bds-element-3 Voorvoegsel geslachtsnaam Basisdataset (BDS) versie 3.2.3
jgz-bds-element-4 Geslachtsnaam Basisdataset (BDS) versie 3.2.3
jgz-bds-element-19 Geslacht Basisdataset (BDS) versie 3.2.3
jgz-bds-element-20 Geboortedatum Basisdataset (BDS) versie 3.2.3
jgz-bds-element-12 Huisnummer Basisdataset (BDS) versie 3.2.3
jgz-bds-element-13 Huisletter Basisdataset (BDS) versie 3.2.3
jgz-bds-element-14 Huisnummertoevoeging Basisdataset (BDS) versie 3.2.3
jgz-bds-element-16 Postcode Basisdataset (BDS) versie 3.2.3
Gebruikt door / Gebruikt
Gebruikt door / Gebruikt 1 template
Gebruikt door Template-id als Naam Versie
2.16.840.1.113883.2.4.6.10.100.16 OpvragenVaccinatiestatus Opvragen vaccinatiestatus (interactie) 2012‑10‑01
Item DT Card Conf Omschrijving Label
hl7:queryByParameter
Bevat de kenmerken van de vraag (OpvragenVaccinatiestatus-payload)
  Voorbeeld <queryByParameter>
  <templateId root="2.16.840.1.113883.2.4.6.10.100.181"/>
  <queryId extension="extdummy" root="1.2.3.4.5"/>
  <statusCode code="executing"/>
  <responseModalityCode code="R"/>
  <responsePriorityCode code="I"/>
  <executionAndDeliveryTime value="20130102100000"/>
  <patientId>
    <value extension="123456782" root="2.16.840.1.113883.2.4.6.3"/>
  </patientId>
  <person.addr>
    <value use="HP">
      <houseNumber>2</houseNumber>      <buildingNumberSuffix>a</buildingNumberSuffix>      <additionalLocator>to</additionalLocator>      <postalCode>1000 AA</postalCode>    </value>
  </person.addr>
  <person.administrativeGender>
    <value code="M" codeSystem="2.16.840.1.113883.5.1"/>
  </person.administrativeGender>
  <person.birthTime>
    <value value="20120504"/>
  </person.birthTime>
  <person.name>
    <value xsi:type="PN">
      <given qualifier="BR">V.</given>      <prefix>van </prefix>      <family qualifier="BR">Achternaam</family>    </value>
  </person.name>
</queryByParameter>
treetree hl7:templateId
II 1 .. 1 M Template-id Opvragen vaccinatiestatus (OpvragenVaccinatiestatus-payload)
treeblank treetree @root
oid 1 .. 1 F 2.16.840.1.113883.2.4.6.10.100.181
treetree hl7:queryId
II 1 .. 1 M Bevat de unieke identificatie van de vraag zoals geformuleerd in de vragende applicatie, los van de identificatie van de interactie waarin de vraag wordt aangeboden. De waarde van dit attribuut wordt in het antwoord teruggeleverd, zodat de antwoordberichten kunnen worden gerelateerd aan de vraag. De OID voor het identificatiesysteem kan bijvoorbeeld worden afgeleid van de URA van de zorgaanbieder, het AORTA applicatie-id, maar dit is geen verplichting. Iedere OID die voldoet aan het principe van uniekheid is geldig. (OpvragenVaccinatiestatus-payload)
  Constraint Deze identificatie is uniek en kan nooit nogmaals worden uitgedeeld, noch door dezelfde applicatie, noch door een andere applicatie. Het identificatiesysteem waaruit de vraagidentificaties worden gegenereerd wordt geïdentificeerd door een OID in het attribuut @root. Het attribuut @extension moet de gegenereerde identificatie bevatten.
treetree hl7:statusCode
CS 1 .. 1 M Bevat de (nieuwe) status van de query. De te gebruiken waarden in dit attribuut zijn gedefinieerd in de valueset QueryStatusCode. (OpvragenVaccinatiestatus-payload)
treeblank treetree @code
1 .. 1 F executing
treetree hl7:modifyCode
NP (OpvragenVaccinatiestatus-payload)
treetree hl7:responseElementGroupId
NP (OpvragenVaccinatiestatus-payload)
treetree hl7:responseModalityCode
CS 1 .. 1 M Definieert de timing en groepering van de antwoordberichten. (OpvragenVaccinatiestatus-payload)
treeblank treetree @code
1 .. 1 F R
treetree hl7:responsePriorityCode
CS 1 .. 1 M Geeft het tijdsframe aan waarbinnen het antwoord wordt verwacht, zoals ‘I’ (Immediate) voor directe beantwoording. De standaardwaarde is "I" (Immediate). Merk op dat ook het tijdstip van beantwoording van de vraag in het vraagbericht zelf kan worden beïnvloed: zie de beschrijving van executionAndDeliveryTime. (OpvragenVaccinatiestatus-payload)
treeblank treetree @code
1 .. 1 F I
treetree hl7:initialQuantity
NP (OpvragenVaccinatiestatus-payload)
treetree hl7:initialQuantityCode
NP (OpvragenVaccinatiestatus-payload)
treetree hl7:executionAndDeliveryTime
TS 0 .. 1 C Bevat het tijdstip waarop het antwoord uiterlijk moet zijn opgeleverd aan het vragende systeem. Het tijdstip wordt relatief aan de aanmaaktijd van de interactie. Het verschil tussen de twee tijdstippen moet liggen tussen de configuratieparameter responsetijd-ZIM (zie [Config inst]) en 60 seconden. Bij afwezigheid van het element executionAndDeliveryTime geldt maximale oplevertimeout zoals beschreven in de Programma’s van Eisen.

FAQ: Hoe bepaalt een zender van een ‘Immediate’ vraagbericht een redelijke waarde voor de oplevertimeout?
- De complexiteit of grootte van het verwachte antwoord is van invloed op het op te geven tijdstip. Indien een volledig overzicht van de medicatiehistorie van een patiënt opgevraagd wordt, dan ligt een ruimere timeout voor de hand dan bij het opvragen van één laboratoriumuitslag.

(OpvragenVaccinatiestatus-payload)
  Constraint @value moet de maximale timeout bevatten, indien de toepassing voor de betreffende interactie specificeert dat een maximale timeout moet kunnen worden opgegeven, en deze in de zendende applicatie ook werkelijk een waarde heeft.
@value moet, indien deze een waarde heeft, tenminste tot op de minuut nauwkeurig worden opgegeven.
Het verschil tussen executionAndDeliveryTime/@value en Message/creationTime/@value moet, indien beide een waarde hebben, liggen tussen responsetijd-ZIM en 60 seconden.
treetree hl7:sortControl
NP (OpvragenVaccinatiestatus-payload)
treetree hl7:patientId
1 .. 1 M Bevat het burgerservicenummer van de patiënt/cliënt van wie de vaccinaties worden opgevraagd (OpvragenVaccinatiestatus-payload)
  Voorbeeld <patientId>
  <value extension="100197231" root="2.16.840.1.113883.2.4.6.3"/>
</patientId>
treeblank treetree hl7:value
II.NL.BSN 1 .. 1 M (OpvragenVaccinatiestatus-payload)
treeblank treeblank treetree @root
oid 1 .. 1 F 2.16.840.1.113883.2.4.6.3
  target Gekoppeld aan concepten:
jgz-bds-element-7 BSN
treetree hl7:person.addr
0 .. 1 R Bevat (delen van) het GBA/COA-adres van de patiënt/cliënt van wie de vaccinaties worden opgevraagd. Er kan niet met jokertekens (wildcards), zoals * en ?, worden gezocht. Alleen de adresdelen huisnummer, huisletter, huisnummertoevoeging en postcode kunnen worden gebruikt aangezien overige adresdelen niet worden opgeslagen. Sturen van bijvoorbeeld woonplaats in het element
country
is echter niet fout en dient door de ontvanger te worden genegeerd. Matchen van letters dient niet-hoofdlettergevoelig te zijn.
(OpvragenVaccinatiestatus-payload)
  Voorbeeld <person.addr>
  <value use="HP">
    <houseNumber>23</houseNumber>    <buildingNumberSuffix>a</buildingNumberSuffix>    <additionalLocator>to</additionalLocator>    <postalCode>1200 BR</postalCode>  </value>
</person.addr>
treeblank treetree hl7:value
AD 1 .. 1 M (OpvragenVaccinatiestatus-payload)
treeblank treeblank treetree @use
set_cs 1 .. 1 R
  CONF
De waarde van @use moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.100.11.2.3 W0003 Soort adres (HL7) (DYNAMISCH)
treeblank treeblank treetree hl7:houseNumber
ST 0 .. 1 Huisnummer (OpvragenVaccinatiestatus-payload)
  target Gekoppeld aan concepten:
jgz-bds-element-12 Huisnummer
treeblank treeblank treetree hl7:buildingNumberSuffix
ST 0 .. 1 Huisletter (OpvragenVaccinatiestatus-payload)
  target Gekoppeld aan concepten:
jgz-bds-element-13 Huisletter
treeblank treeblank treetree hl7:additionalLocator
ST 0 .. 1 Huisnummertoevoeging. Kan de waarde 'to' (tegenover) of 'by' (bij) bevatten. (OpvragenVaccinatiestatus-payload)
  target Gekoppeld aan concepten:
jgz-bds-element-14 Huisnummertoevoeging
  Schematron assert role red error
  test text()=('to','by')
  Melding <name path=".."/>/<name/> MOET 'to' of 'by' zijn
treeblank treeblank treetree hl7:postalCode
SC 0 .. 1 Postcode. Formaat voor Nederlandse postcodes is "nnnn AA", dus met spatie. (OpvragenVaccinatiestatus-payload)
  target Gekoppeld aan concepten:
jgz-bds-element-16 Postcode
treetree hl7:person.administrativeGender
0 .. 1 R Bevat het geslacht van de patiënt/cliënt van wie de vaccinaties worden opgevraagd (OpvragenVaccinatiestatus-payload)
  Voorbeeld <person.administrativeGender>
  <value code="M" codeSystem="2.16.840.1.113883.5.1"/>
</person.administrativeGender>
treeblank treetree hl7:value
CV 1 .. 1 R (OpvragenVaccinatiestatus-payload)
  CONF
De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.100.11.2.23 W0023 Geslacht (HL7) (DYNAMISCH)
  target Gekoppeld aan concepten:
jgz-bds-element-19 Geslacht
treetree hl7:person.birthTime
0 .. 1 R Bevat in element
value
de geboortedatum van de patiënt/cliënt van wie de vaccinaties worden opgevraagd
(OpvragenVaccinatiestatus-payload)
  Voorbeeld <person.birthTime>
  <value value="19750103"/>
</person.birthTime>
treeblank treetree hl7:value
TS 1 .. 1 M (OpvragenVaccinatiestatus-payload)
  target Gekoppeld aan concepten:
jgz-bds-element-20 Geboortedatum
treetree hl7:person.name
0 .. 1 R Bevat (delen van) de GBA-naam van de patiënt/cliënt van wie de vaccinaties worden opgevraagd. Er kan niet met jokertekens (wildcards), zoals * en ?, worden. Alleen de naamdelen voornaam, voorvoegsel geslachtsnaam, en geslachtsnaam kunnen worden gebruikt aangezien overige naamdelen niet worden opgeslagen. Sturen van bijvoorbeeld voorletters in het element
given
is echter niet fout en dient door de ontvanger te worden genegeerd. Matchen van letters dient niet-hoofdlettergevoelig te zijn.
(OpvragenVaccinatiestatus-payload)
  Voorbeeld <person.name>
  <value>
    <given>Alfred</given>    <prefix qualifier="VV BR">de </prefix>    <family qualifier="BR">Groot</family>  </value>
</person.name>
treeblank treetree hl7:value
PN 1 .. 1 M (OpvragenVaccinatiestatus-payload)
treeblank treeblank treetree hl7:given
ENXP 0 .. 1 Voornaam of voornamen gescheiden door een spatie (OpvragenVaccinatiestatus-payload)
treeblank treeblank treeblank treetree @qualifier
set_cs 0 .. 1 F BR
  target Gekoppeld aan concepten:
jgz-bds-element-6 Voornaam
treeblank treeblank treetree hl7:prefix
ENXP 0 .. 1 Voorvoegsel(s) (OpvragenVaccinatiestatus-payload)
treeblank treeblank treeblank treetree @qualifier
set_cs 1 .. 1 R
  CONF
@qualifier moet "VV" zijn
of
@qualifier moet "BR" zijn
  target Gekoppeld aan concepten:
jgz-bds-element-3 Voorvoegsel geslachtsnaam
treeblank treeblank treetree hl7:family
ENXP 0 .. 1 Geslachtnaam (OpvragenVaccinatiestatus-payload)
treeblank treeblank treeblank treetree @qualifier
set_cs 1 .. 1 F BR
  target Gekoppeld aan concepten:
jgz-bds-element-4 Geslachtsnaam