Terug naar index  <<  Terug naar templates

 Template  Opleveren vaccinatiestatus (interactie)

Template 2.16.840.1.113883.2.4.6.10.100.17 - OpleverenVaccinatiestatus
Id 2.16.840.1.113883.2.4.6.10.100.17
Context Padnaam hl7:REPC_IN002171NL
Versie geldig vanaf 2012‑10‑01 status Actief
Open/gesloten Open (ook andere dan gedefinieerde elementen zijn toegestaan)
Omschrijving

Opleveren vaccinatiestatus. Dit bericht bevat minimaal 0 en maximaal n:

  • ontvangen (en goedgekeurde) vaccinaties;
  • vaccinaties waartegen bezwaar is geuit;
  • te-verwachten-vaccinaties.
Er kunnen ook buitenlandse vaccinaties bij zitten voor zover bekend: hiervan is geen "goedkeuring" bekend en het is mogelijk dat het vaccintype nog geen code heeft. Zie verder de specificaties bij dit element. De waarde voor het element acceptAckCode is "NE".

Item DT Card Conf Desc Label
Ingevoegd van TransmissionWrapper Application Ack (2012‑08‑01)
hl7:id
II 1 .. 1 R Bericht-id (OpleverenVaccinatiestatus)
Schematron assert role red error
test @root and @extension
Melding Transmission: id element mist root of extension
hl7:creationTime
TS.DATETIME.MIN 1 .. 1 R Bericht-aanmaakdatum/tijd (OpleverenVaccinatiestatus)
Constraint creationTime moet minimaal op de seconde nauwkeurig zijn
hl7:versionCode
CS 1 .. 1 R Bericht-versiecode (OpleverenVaccinatiestatus)
treetree @code
1 .. 1 F NICTIZEd2005-Okt
hl7:interactionId
II 1 .. 1 R Bericht-interactie-id (OpleverenVaccinatiestatus)
treetree @root
1 .. 1 F 2.16.840.1.113883.1.6
Variabele let Naam interactionId
Waarde self::node()[@root='2.16.840.1.113883.1.6']/@extension
Schematron assert role red error
test not(@root='2.16.840.1.113883.1.6') or local-name(..)=@extension
Melding Transmission: @extension moet overeenkomen met het startelement van het bericht
hl7:profileId
II 1 .. 1 R Bericht-profile-id (OpleverenVaccinatiestatus)
treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.3.11.1
treetree @extension
1 .. 1 F 810
hl7:processingCode
CS 1 .. 1 R Bericht-verwerkingsmodus (OpleverenVaccinatiestatus)
treetree @code
1 .. 1 F P
hl7:processingModeCode
CS 1 .. 1 R Bericht-verwerkingsmodus (OpleverenVaccinatiestatus)
treetree @code
1 .. 1 F T
hl7:acceptAckCode
CS 1 .. 1 R Verwacht een ontvangstbevestiging (OpleverenVaccinatiestatus)
treetree @code
1 .. 1 F NE
hl7:acknowledgement
1 .. 1 R Details van de bevestiging (OpleverenVaccinatiestatus)
treetree @typeCode
1 .. 1   @typeCode moet één zijn van:
  • AA
  • AE
  • AR
Voorbeeld
<acknowledgement typeCode="CA">
  <targetMessage>
    <id extension="200103" root="2.16.528.1.1007.3.3.112233.1"/>
  </targetMessage>
</acknowledgement>
Schematron assert role orange warning
test @typeCode='AA' or @typeCode='CA' or hl7:acknowledgementDetail
Melding Transmission: negatieve antwoordberichten moeten ook een reden hebben waarom
treetree hl7:acknowledgementDetail
0 .. * C Bevat foutmeldingen (OpleverenVaccinatiestatus)
treeblank treetree @typeCode
0 .. 1 F E
Constraint Verplicht aanwezig indien het geen positieve ontvangstbevestiging is
Schematron assert role red error
test hl7:code[@code and @displayName] or hl7:text
Melding Transmission: er moet een toelichting op de fout/waarschuwing zijn in hl7:code/@displayName of text
treeblank treetree hl7:code
CV 1 .. 1 M Foutcode (OpleverenVaccinatiestatus)
Schematron assert role orange warning
test @displayName or @codeSystem='2.16.840.1.113883.5.1100' or @codeSystem='2.16.840.1.113883.2.4.6.6.1.1000' or @codeSystem='2.16.840.1.113883.5.4'
Melding Transmission: als de code niet uit een van de standaardcodesystemen '2.16.840.1.113883.5.1100', '2.16.840.1.113883.2.4.6.6.1.1000', of '2.16.840.1.113883.5.4' komt is het @displayName attribuut verplicht
treeblank treetree hl7:text
ST 0 .. 1 R Fouttext (OpleverenVaccinatiestatus)
treeblank treetree hl7:location
ST 0 .. * R Foutlocatie. Kan bijvoorbeeld een XPath-expressie zijn waar de fout optrad (OpleverenVaccinatiestatus)
treetree hl7:targetMessage
1 .. 1 M Bevat de referentiedetails van het bericht waarop wordt geantwoord (OpleverenVaccinatiestatus)
treeblank treetree hl7:id
II 1 .. 1 M Identificatie van het bericht waarop wordt geantwoord (OpleverenVaccinatiestatus)
Ingevoegd van TransmissionWrapper Receiver not ZIM (2012‑08‑01) 1 .. 1 Verplicht Vereist
hl7:receiver
1 .. 1 M Transmission wrapper receiver welke niet AORTA applicatie-id '1' heeft. Dit is de bedoelde AORTA-ontvanger van een interactie. (OpleverenVaccinatiestatus)
treetree @typeCode
0 .. 1 F RCV
Voorbeeld
<receiver>
  <device>
    <id extension="222233445" root="2.16.840.1.113883.2.4.6.6"/>
    <name>Applicatienaam ontvanger</name>
  </device>
</receiver>
treetree hl7:device
1 .. 1 M Ontvanger-apparaat (OpleverenVaccinatiestatus)
treeblank treetree hl7:id
II 1 .. 1 M Applicatie-id (OpleverenVaccinatiestatus)
treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.6.6
Schematron assert role red error
test @root='2.16.840.1.113883.2.4.6.6' and not(@extension='1')
Melding Transmission: receiver/device/id mag niet de AORTA ZIM zijn
treeblank treetree hl7:name
EN 0 .. 1 Applicatie-naam (OpleverenVaccinatiestatus)
Ingevoegd van TransmissionWrapper Sender not ZIM (2012‑08‑01) 1 .. 1 Verplicht Vereist
hl7:sender
1 .. 1 M Transmission wrapper sender welke niet AORTA applicatie-id '1' heeft. Dit is de AORTA-zender van een interactie. (OpleverenVaccinatiestatus)
treetree @typeCode
0 .. 1 F SND
Voorbeeld
<sender>
  <device>
    <id extension="222233445" root="2.16.840.1.113883.2.4.6.6"/>
    <name>Applicatienaam zender</name>
  </device>
</sender>
treetree hl7:device
1 .. 1 M Zendend-apparaat (OpleverenVaccinatiestatus)
treeblank treetree hl7:id
II 1 .. 1 M Applicatie-id (OpleverenVaccinatiestatus)
treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.6.6
Schematron assert role red error
test @root='2.16.840.1.113883.2.4.6.6' and not(@extension='1')
Melding Transmission: sender/device/id mag niet de AORTA ZIM zijn
treeblank treetree hl7:name
EN 0 .. 1 Applicatie-naam (OpleverenVaccinatiestatus)
hl7:ControlActProcess
1 .. 1 M Bevat transactionele informatie (OpleverenVaccinatiestatus)
Voorbeeld
<ControlActProcess>
  <authorOrPerformer typeCode="AUT">
    <!-- ... -->
  </authorOrPerformer>
  <overseer>
    <!-- ... -->
  </overseer>
</ControlActProcess>
Ingevoegd van ControlAct Query Response / Acknowledgement (2012‑10‑01)
treetree @moodCode
1 .. 1 F EVN
treetree hl7:id
II 0 .. 1 R Trigger event identificatie (OpleverenVaccinatiestatus)
treetree hl7:code
CV 0 .. 1 R Trigger event code (OpleverenVaccinatiestatus)
treeblank treetree @codeSystem
1 .. 1 F 2.16.840.1.113883.1.18 (HL7-Trigger Events)
treetree hl7:text
NP (OpleverenVaccinatiestatus)
treetree hl7:effectiveTime
TS 0 .. 1 R Datum/tijd waarop het trigger event plaatsvond dat leidde tot dit bericht (OpleverenVaccinatiestatus)
treetree hl7:reasonCode
NP (OpleverenVaccinatiestatus)
treetree hl7:languageCode
NP (OpleverenVaccinatiestatus)
treetree hl7:informationRecipient
NP (OpleverenVaccinatiestatus)
treetree hl7:dataEnterer
NP (OpleverenVaccinatiestatus)
treetree hl7:reasonOf
0 .. * (OpleverenVaccinatiestatus)
treetree hl7:queryAck
0 .. 1 R Bevat de metakenmerken van het antwoord (OpleverenVaccinatiestatus)
treeblank treetree hl7:queryId
II 1 .. 1 M Bevat de unieke identificatie van de vraag. De waarde van dit attribuut is gelijk aan de waarde van QueryByParameter/queryId uit de vraag De aanvrager kan hierdoor de antwoordberichten relateren aan de vraag. (OpleverenVaccinatiestatus)
treeblank treetree hl7:statusCode
CS 0 .. 1 R Bevat de (nieuwe) status van de query. De te gebruiken waarden in dit attribuut zijn gedefinieerd in de valueset QueryStatusCode. (OpleverenVaccinatiestatus)
Constraint @code moet, indien aanwezig, de waarde "aborted" bevatten als de antwoordinteractie het antwoord vormt op een verzoek om de vraagsessie af te breken.
Constraint @code moet, indien aanwezig, de waarde "deliveredResponse" bevatten in alle andere gevallen.
CONF
@code moet "aborted" zijn
of
@code moet "deliveredResponse" zijn
treeblank treetree hl7:queryResponseCode
CS 1 .. 1 M Bevat een statusmelding betreffende het antwoord. Waarden zijn ‘OK’ (Data found), ‘NF’ (Nothing found, No errors), ‘AE’ (Applicatie probleem, beantwoording afgebroken) en ‘QE’ (Query Parameter Error, beantwoording afgebroken). De te gebruiken waarden zijn gedefinieerd in de QueryResponse vocabulaire. Indien er geen zoekresultaten bij een vraag opgeleverd kunnen worden, omdat bijvoorbeeld de in de vraag geleverde parameters niet tot een zoekresultaat leiden, dan bevat het antwoordbericht nul opgeleverde antwoorden en het queryResponseCode de waarde "NF". Het vinden van nul antwoorden is op zichzelf geen fout, Acknowledgement/@typeCode bevat om die reden "AA" indien queryResponseCode/@code "NF" is. (OpleverenVaccinatiestatus)
Constraint @code moet "OK" bevatten als de resultaten op basis van de vraag geheel of gedeeltelijk worden opgeleverd
Constraint @code moet "NF" bevatten als op basis van de opgegeven filterparameters geen resultaten konden worden gevonden, maar verder ook geen fouten zijn opgetreden.
Constraint @code moet "QE" bevatten als er problemen zijn met de verwerking van de filterparameters, zoals zoeken op UZI-nummer in een parameter welke bedoeld is voor zoeken op UZI-registerabonneenummmers, zoeken op gegevenssoort met een parameter die bedoeld is voor rolcode, of zoeken in een periode die ligt buiten een gespecificeerd bereik. Er zijn in dit geval geen resultaten en de vraagsessie is afgebroken.
Constraint @code moet "AE" bevatten als er applicatieproblemen zijn opgetreden. Er zijn in dit geval geen resultaten en de vraagsessie is afgebroken.
CONF
@code moet "OK" zijn
of
@code moet "NF" zijn
of
@code moet "QE" zijn
of
@code moet "AE" zijn
treeblank treetree hl7:resultTotalQuantity
INT 1 .. 1 R Bevat de totale hoeveelheid zoekresultaten die geleverd (kunnen) worden als antwoord op de vraag.

Merk op dat een antwoordend systeem, ook in het geval van een ongedoseerde vraag de omvang van het antwoord kan beperken, bijvoorbeeld om resource-technische redenen. In dat geval moet de vraagsteller vervolgvragen sturen om alle antwoorden te verkrijgen.
Als een systeem geen vervolgvragen kan beantwoorden, moet een systeem omwille van de volledigheid alle gevraagde zoekresultaten in één keer opleveren.
Merk op dat het "doseermechanisme" op dit moment in AORTA niet gebruikt mag worden. Het element QueryByParameter/initialQuantity attribuut mag om die reden niet gebruikt worden. Opleverende systemen dienen alle zoekresultaten in één antwoordbericht op te leveren.

(OpleverenVaccinatiestatus)
Constraint @value moet een waarde bevatten, of als de totale hoeveelheid zoekresultaten (nog) niet bekend is moet @nullFlavor de waarde "NAV" bevatten.
treeblank treetree hl7:resultCurrentQuantity
INT 1 .. 1 R Bevat de hoeveelheid antwoorden die opgenomen zijn in het huidige bericht. Een antwoordbericht kan meerdere antwoorden bevatten. Bevat de hoeveelheid antwoorden die opgenomen zijn in het huidige bericht. (OpleverenVaccinatiestatus)
Constraint @value moet een waarde bevatten.
treeblank treetree hl7:resultRemainingQuantity
INT 1 .. 1 R Bevat de hoeveelheid zoekresultaten die (nog) niet verstuurd zijn aan de aanvrager. De aanwezigheid van de @nullFlavor met waarde "NAV" mag niet worden geïnterpreteerd als "0".

Uitgaande van de oplevering van een reeks antwoordberichten zonder foutmeldingen:
In de reeks antwoordberichten (al dan niet gebundeld) dient resultTotalQuantity in alle berichten dezelfde waarde te bevatten en resultRemainingQuantity (in grootte zoals opgegeven in het resultCurrentQuantity element) af te nemen naar de waarde 0.
De elementen resultTotalQuantity en resultRemainingQuantity kunnen aan het begin van de reeks antwoordberichten worden gevuld met een null-waarde indien de waarden nog niet bekend zijn. Het laatste bericht in de reeks antwoordberichten mag echter geen null-waarden in deze elementen bevatten.

(OpleverenVaccinatiestatus)
Constraint @value moet een waarde bevatten, of als de totale hoeveelheid zoekresultaten (nog) niet bekend is moet @nullFlavor de waarde "NAV" bevatten.
Ingevoegd van ControlAct AuthorOrPerformer Device (2012‑08‑01) 1 .. 1 Verplicht Vereist
treetree hl7:authorOrPerformer
waar
[*/hl7:AssignedDevice]
1 .. 1 M Bericht-zender. Apparaat (OpleverenVaccinatiestatus)
treeblank treetree @typeCode
0 .. 1 F AUT
Voorbeeld
<!-- Applicatie in een GBZ -->
<authorOrPerformer typeCode="AUT">
  <participant>
    <AssignedDevice>
      <id root="2.16.528.1.1007.3.2" extension="900000262"/>
      <id root="2.16.840.1.113883.2.4.6.6" extension="1234"/>
      <Organization>
        <id root="2.16.528.1.1007.3.3" extension="00000509"/>
        <name>Organisatienaam</name>
      </Organization>
    </AssignedDevice>
  </participant>
</authorOrPerformer>
Voorbeeld
<!-- Applicatie in een GBO -->
<authorOrPerformer typeCode="AUT">
  <participant>
    <AssignedDevice>
      <id root="2.16.840.1.113883.2.4.6.6" extension="1234"/>
      <Organization>
        <id root="2.16.840.1.113883.2.4.3.11.25" extension="100001"/>
        <name>RIVM</name>
      </Organization>
    </AssignedDevice>
  </participant>
</authorOrPerformer>
treeblank treetree hl7:participant
1 .. 1 M Koppelt systeemgegevens aan de auteur. Er zijn een aantal typen applicaties:
  • XIS in een GBZ - Organisatie is geregistreerd in het UZI-register en heeft een URA. Applicatie heeft een UZI-systeemcertificaat en een UZI-systeemnummer (en een AORTA-applicatie-id). Het DD-JGZ is zo'n applicatie
  • XIS in een GBO - Organisatie is geregistreerd als AORTA-organisatie en heeft een AORTA-organisatie-id. Applicatie heeft een PKIo-certificaat en een AORTA-applicatie-id. Praeventis is zo'n applicatie
  • Patiëntenportaal in een GBP - Niet van toepassing binnen Jeugdgezondheidszorg
  • Klantenloket in een GBK - Niet van toepassing binnen Jeugdgezondheidszorg
Zie verder de AORTA Infrastructuur en specifiek de AORTA Implementatiehandleiding wrappers voor achtergrond. 		(OpleverenVaccinatiestatus)
treeblank treeblank treetree hl7:AssignedDevice
1 .. 1 M Systeemgegevens (OpleverenVaccinatiestatus)
Schematron assert role red error
test not(hl7:id[@root='2.16.528.1.1007.3.2']) or hl7:Organization[hl7:id[@root='2.16.528.1.1007.3.3']]
Melding <name/> met een UZI-systeemnummer in id MOET als bij de organisatie een URA hebben.
Schematron assert role red error
test not(hl7:id[@root='2.16.528.1.1007.3.2'] and hl7:Organization[hl7:id[@root='2.16.840.1.113883.2.4.3.11.25']])
Melding <name/> met een UZI-systeemnummer in id MAG GEEN AORTA-organisatie-id als hebben.
Keuze min 1 element(en) en max 2 element(en). Elementen om uit te kiezen:
  • hl7:id[@root='2.16.840.1.113883.2.4.6.6']
  • hl7:id[@root='2.16.528.1.1007.3.2']
treeblank treeblank treeblank treeblank treetree hl7:id
II M AORTA-applicatie-id (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.6.6
treeblank treeblank treeblank treeblank treetree hl7:id
II.NL.UZI M UZI-systeemnummer conform UZI-systeemcertificaat (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 2.16.528.1.1007.3.2
treeblank treeblank treeblank treetree hl7:code
CV 0 .. 1 (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:telecom
TEL 0 .. 1 Systeem-telecommunicatieadres (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:name
PN 0 .. 1 Systeem-naam (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:noteText
NP (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:time
NP (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:modeCode
NP (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:signatureCode
NP (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:signatureText
NP (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treetree hl7:Organization
0 .. 1 C Zorgaanbieder/organisatiegegevens (OpleverenVaccinatiestatus)
Constraint De organisatiegegevens zijn verplicht voor het GBZ- en GBO-applicaties, het Klantenloket in het GBK en Patiëntenportalen in een GBP.
Constraint Het centrale component in AORTA, de Zorg Informatie Makelaar (ZIM) heeft geen organisatiegegevens
Keuze min 1 element(en) en max 1 element(en). 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.3.11']
  • hl7:id[@root='2.16.840.1.113883.2.4.3.11.25']
treeblank treeblank treeblank treeblank treeblank treetree hl7:id
II.NL.URA M Zorgaanbieder-id (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 2.16.528.1.1007.3.3
treeblank treeblank treeblank treeblank treeblank treetree hl7:id
II M Organisatie-id klantenloket (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.3.11
treeblank treeblank treeblank treeblank treeblank treeblank treetree @extension
1 .. 1 F 7
treeblank treeblank treeblank treeblank treeblank treetree hl7:id
II M Organisatie-id GBO (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treeblank treetree @root
1 .. 1 F 2.16.840.1.113883.2.4.3.11.25
treeblank treeblank treeblank treeblank treetree hl7:code
CV 0 .. 1 R Organisatietype. Geldige waarden komen uit RoleCodeNL - zorgaanbiedertype (2.16.840.1.113883.2.4.15.1060). Er is (nog) geen type gedefinieerd voor GBO-organisaties zoals het RIVM. (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treeblank treetree @codeSystem
1 .. 1 F 2.16.840.1.113883.2.4.15.1060 (RoleCodeNLUZIRoleCodeOrganisaties)
treeblank treeblank treeblank treeblank treetree hl7:telecom
TEL 0 .. * Zorgaanbieder-telecommunicatieadres (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treetree hl7:name
ON 1 .. 1 M Zorgaanbieder-naam/organisatie-naam. De naam moet bij voorkeur komen van het gebruikte systeemcertificaat. Bij PKIo-certificaten is dat de waarde uit het veld "O" (Organization) (OpleverenVaccinatiestatus)
treeblank treeblank treeblank treeblank treetree hl7:addr
AD 0 .. 1 Zorgaanbieder-adres (OpleverenVaccinatiestatus)
treetree hl7:subject
waar
[hl7:VaccinationAdministrationList [hl7:templateId [@root='2.16.840.1.113883.2.4.6.10.100.182']]]
1 .. 1 M Koppelt de inhoud aan de wrappers (OpleverenVaccinatiestatus)
treeblank treetree @typeCode
0 .. 1 F SUBJ
Voorbeeld
<subject>
  <!-- ... -->
</subject>
Bevat geërfde templateregels Bericht 2 Opleveren vaccinatiestatus (payload) (2012‑09‑01) met overschreven kardinaliteit 1 .. 1 Verplicht Vereist