Template 2.16.840.1.113883.2.4.6.10.100.16

Template Opvragen vaccinatiestatus (interactie)

Template 2.16.840.1.113883.2.4.6.10.100.16 - OpvragenVaccinatiestatus

Id 2.16.840.1.113883.2.4.6.10.100.16

Context Padnaam hl7:REPC_IN002170NL

Versie geldig vanaf 2012‑10‑01 status Actief

Open/gesloten Open (ook andere dan gedefinieerde elementen zijn toegestaan)

Omschrijving

Opvragen vaccinatiestatus. Er zijn een aantal generieke elementen met specifieke vulling:

Het gebruik van het element hl7:attentionLine is verplicht met daarin het BSN van de persoon voor wie de vaccinatiestatus wordt opgevraagd.
Het applicatie-id van het RIVM komt in hl7:receiver/hl7:device/hl7:id
hl7:acceptAckCode/@code moet de waarde NE bevatten
hl7:queryByParameter/hl7:responseModalityCode/@code moet de waarde 'R' bevatten

De waarde voor het element acceptAckCode is "NE".

Gebruikt door / Gebruikt

Gebruikt door / Gebruikt 8 templates

Gebruikt Template Id	Naam	vanaf
jgz-template-100	TransmissionWrapperMCCI_MT000100	2012‑08‑01
jgz-template-100.1	TransmissionWrapperReceiverNotZIM	2012‑08‑01
jgz-template-100.3	TransmissionWrapperSenderNotZIM	2012‑08‑01
jgz-template-181	OpvragenVaccinatiestatus-payload	2012‑09‑01
jgz-template-201	ControlActWrapperQUQI_MT021001	2012‑10‑01
jgz-template-200.1	ControlActAuthorOrPerformerDevice	2012‑08‑01
jgz-template-200.2	ControlActAuthorOrPerformerPerson	2012‑08‑01
jgz-template-201.2	ControlActOverseerPersonQuery	2012‑10‑01

Item DT Card Conf Desc Label

Ingevoegd van TransmissionWrapper Initiating (2012‑08‑01)

hl7:id

1 .. 1

Bericht-id

(OpvragenVaccinatiestatus)

Schematron assert role error

test @root and @extension

Melding Transmission: id element mist root of extension

hl7:creationTime

TS.DATETIME.MIN

1 .. 1

Bericht-aanmaakdatum/tijd

(OpvragenVaccinatiestatus)

Constraint creationTime moet minimaal op de seconde nauwkeurig zijn

hl7:versionCode

1 .. 1

Bericht-versiecode

(OpvragenVaccinatiestatus)

@code

1 .. 1

NICTIZEd2005-Okt

hl7:interactionId

1 .. 1

Bericht-interactie-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

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 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

1 .. 1

Bericht-profile-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.3.11.1

@extension

1 .. 1

810

hl7:processingCode

1 .. 1

Bericht-verwerkingsmodus

(OpvragenVaccinatiestatus)

@code

1 .. 1

hl7:processingModeCode

1 .. 1

Bericht-verwerkingsmodus

(OpvragenVaccinatiestatus)

@code

1 .. 1

hl7:acceptAckCode

1 .. 1

Verwacht een ontvangstbevestiging. De juiste waarde hangt af van het gedefinieerde antwoord in de transactiegroep van het scenario. Als het gedefinieerde antwoord een Ontvangstbevestiging ("MCCI_IN000002") is, dan moet de waarde "AL" zijn. In alle andere gevallen moet de waarde "NE" zijn.

(OpvragenVaccinatiestatus)

CONF

@code moet "AL" zijn

@code moet "NE" zijn

Ingevoegd van TransmissionWrapper Receiver not ZIM (2012‑08‑01) 1 .. 1 Verplicht Vereist

hl7:receiver

1 .. 1

Transmission wrapper receiver welke niet AORTA applicatie-id '1' heeft. Dit is de bedoelde AORTA-ontvanger van een interactie.

(OpvragenVaccinatiestatus)

@typeCode

0 .. 1

RCV

Voorbeeld

<receiver> <device> <id extension="222233445" root="2.16.840.1.113883.2.4.6.6"/> <name>Applicatienaam ontvanger</name> </device> </receiver>

hl7:device

1 .. 1

Ontvanger-apparaat

(OpvragenVaccinatiestatus)

hl7:id

1 .. 1

Applicatie-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.6.6

Schematron assert role 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

hl7:name

0 .. 1

Applicatie-naam

(OpvragenVaccinatiestatus)

Ingevoegd van TransmissionWrapper Sender not ZIM (2012‑08‑01) 1 .. 1 Verplicht Vereist

hl7:sender

1 .. 1

Transmission wrapper sender welke niet AORTA applicatie-id '1' heeft. Dit is de AORTA-zender van een interactie.

(OpvragenVaccinatiestatus)

@typeCode

0 .. 1

SND

Voorbeeld

<sender> <device> <id extension="222233445" root="2.16.840.1.113883.2.4.6.6"/> <name>Applicatienaam zender</name> </device> </sender>

hl7:device

1 .. 1

Zendend-apparaat

(OpvragenVaccinatiestatus)

hl7:id

1 .. 1

Applicatie-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.6.6

Schematron assert role 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

hl7:name

0 .. 1

Applicatie-naam

(OpvragenVaccinatiestatus)

hl7:ControlActProcess
waar
[hl7:queryByParameter [hl7:templateId [@root='2.16.840.1.113883.2.4.6.10.100.181']]]

1 .. 1

Bevat transactionele informatie

(OpvragenVaccinatiestatus)

Voorbeeld

<ControlActProcess> <authorOrPerformer typeCode="AUT">  </authorOrPerformer> <overseer>  </overseer> </ControlActProcess>

Bevat geërfde templateregels Bericht 1 Opvragen vaccinatiestatus (payload) (2012‑09‑01) met overschreven kardinaliteit 1 .. 1 Verplicht Vereist

Ingevoegd van ControlAct QueryByParameter as Stub (2012‑10‑01)

@moodCode

1 .. 1

EVN

hl7:id

0 .. 1

Trigger event identificatie

(OpvragenVaccinatiestatus)

hl7:code

0 .. 1

Trigger event code

(OpvragenVaccinatiestatus)

@codeSystem

1 .. 1

2.16.840.1.113883.1.18 (HL7-Trigger Events)

hl7:text

(OpvragenVaccinatiestatus)

hl7:effectiveTime

0 .. 1

Datum/tijd waarop het trigger event plaatsvond dat leidde tot dit bericht

(OpvragenVaccinatiestatus)

hl7:reasonCode

(OpvragenVaccinatiestatus)

hl7:languageCode

(OpvragenVaccinatiestatus)

hl7:informationRecipient

(OpvragenVaccinatiestatus)

hl7:dataEnterer

(OpvragenVaccinatiestatus)

hl7:reasonOf

0 .. *

(OpvragenVaccinatiestatus)

Keuze min 1 element(en) en max 1 element(en). Elementen om uit te kiezen:

hl7:authorOrPerformer[*/hl7:AssignedDevice] ingevoegd uit template ControlAct AuthorOrPerformer Device (2012‑08‑01)
hl7:authorOrPerformer[*/hl7:AssignedPerson] ingevoegd uit template ControlAct AuthorOrPerformer Person (2012‑08‑01)

Ingevoegd van ControlAct AuthorOrPerformer Device (2012‑08‑01) Verplicht Vereist

hl7:authorOrPerformer
waar
[*/hl7:AssignedDevice]

Bericht-zender. Apparaat

(OpvragenVaccinatiestatus)

@typeCode

0 .. 1

AUT

Voorbeeld

 <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

 <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>

hl7:participant

1 .. 1

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.

(OpvragenVaccinatiestatus)

hl7:AssignedDevice

1 .. 1

Systeemgegevens

(OpvragenVaccinatiestatus)

Schematron assert role 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 bij de organisatie een URA hebben.

Schematron assert role 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']

hl7:id

0 .. 1

AORTA-applicatie-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.6.6

hl7:id

II.NL.UZI

0 .. 1

UZI-systeemnummer conform UZI-systeemcertificaat

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.528.1.1007.3.2

hl7:code

0 .. 1

(OpvragenVaccinatiestatus)

hl7:telecom

TEL

0 .. 1

Systeem-telecommunicatieadres

(OpvragenVaccinatiestatus)

hl7:name

0 .. 1

Systeem-naam

(OpvragenVaccinatiestatus)

hl7:noteText

(OpvragenVaccinatiestatus)

hl7:time

(OpvragenVaccinatiestatus)

hl7:modeCode

(OpvragenVaccinatiestatus)

hl7:signatureCode

(OpvragenVaccinatiestatus)

hl7:signatureText

(OpvragenVaccinatiestatus)

hl7:Organization

0 .. 1

Zorgaanbieder/organisatiegegevens

(OpvragenVaccinatiestatus)

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']

hl7:id

II.NL.URA

Zorgaanbieder-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.528.1.1007.3.3

hl7:id

Organisatie-id klantenloket

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.3.11

@extension

1 .. 1

hl7:id

Organisatie-id GBO

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.840.1.113883.2.4.3.11.25

hl7:code

0 .. 1

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.

(OpvragenVaccinatiestatus)

@codeSystem

1 .. 1

2.16.840.1.113883.2.4.15.1060 (RoleCodeNLUZIRoleCodeOrganisaties)

hl7:telecom

TEL

0 .. *

Zorgaanbieder-telecommunicatieadres

(OpvragenVaccinatiestatus)

hl7:name

1 .. 1

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)

(OpvragenVaccinatiestatus)

hl7:addr

0 .. 1

Zorgaanbieder-adres

(OpvragenVaccinatiestatus)

Ingevoegd van ControlAct AuthorOrPerformer Person (2012‑08‑01) Verplicht Vereist

hl7:authorOrPerformer
waar
[*/hl7:AssignedPerson]

Bericht-zender (gemandateerde). Zorgverlener en zorgaanbieder

(OpvragenVaccinatiestatus)

@typeCode

0 .. 1

AUT

Voorbeeld

<authorOrPerformer typeCode="AUT"> <participant> <AssignedPerson> <id root="2.16.528.1.1007.3.1" extension="091287345"/> <code code="01.055" codeSystem="2.16.840.1.113883.2.4.15.111"/> <Organization> <id extension="11223344" root="2.16.528.1.1007.3.3"/> <name>Organisatienaam</name> </Organization> </AssignedPerson> </participant> </authorOrPerformer>

hl7:participant

1 .. 1

Koppelt de persoonsgegevens aan de auteur. Op AORTA bestaan er ook andere auteurs dan zorgverleners (patiënten, wettelijke vertegenwoordigers, klantenloketmedewerkers), maar deze zijn niet van toepassing binnen de Jeugdgezondheidszorg.

(OpvragenVaccinatiestatus)

hl7:AssignedPerson

1 .. 1

Persoonsgegevens

(OpvragenVaccinatiestatus)

hl7:id

II.NL.UZI

1 .. 1

Zorgverlener-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.528.1.1007.3.1

hl7:code

0 .. 1

Zorgverlener-code

(OpvragenVaccinatiestatus)

Schematron assert role error

test @codeSystem='2.16.840.1.113883.2.4.15.111' and not(@code='00.000')

Melding Control Act: <name path=".."/>/<name/> moet een UZI-rolcode bevatten en deze mag niet 00.000 zijn

hl7:telecom

TEL

0 .. 1

Zorgverlener-telecommunicatieadres

(OpvragenVaccinatiestatus)

hl7:name

0 .. 1

Zorgverlener-naam

(OpvragenVaccinatiestatus)

hl7:noteText

(OpvragenVaccinatiestatus)

hl7:time

(OpvragenVaccinatiestatus)

hl7:modeCode

(OpvragenVaccinatiestatus)

hl7:signatureCode

(OpvragenVaccinatiestatus)

hl7:signatureText

(OpvragenVaccinatiestatus)

hl7:Organization

1 .. 1

Zorgaanbieder

(OpvragenVaccinatiestatus)

hl7:id

II.NL.URA

1 .. 1

Zorgaanbieder-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.528.1.1007.3.3

hl7:code

0 .. 1

Organisatietype. Geldige waarden komen uit RoleCodeNL - zorgaanbiedertype (2.16.840.1.113883.2.4.15.1060)

(OpvragenVaccinatiestatus)

@codeSystem

1 .. 1

2.16.840.1.113883.2.4.15.1060 (RoleCodeNLUZIRoleCodeOrganisaties)

hl7:telecom

TEL

0 .. *

Zorgaanbieder-telecommunicatieadres

(OpvragenVaccinatiestatus)

hl7:name

1 .. 1

Zorgaanbieder-naam. De naam moet bij voorkeur komen van het gebruikte systeemcertificaat.

(OpvragenVaccinatiestatus)

hl7:addr

0 .. 1

Zorgaanbieder-adres

(OpvragenVaccinatiestatus)

Ingevoegd van ControlAct Overseer Person Query (2012‑10‑01) 0 .. 1 Verplicht

hl7:overseer

0 .. 1

Bericht-zender (mandaatverlener). Zorgverlener en zorgaanbieder

(OpvragenVaccinatiestatus)

@typeCode

0 .. 1

RESP

Voorbeeld

<overseer typeCode="RESP"> <assignedEntity> <id root="2.16.528.1.1007.3.1" extension="091287345"/> <code code="01.055" codeSystem="2.16.840.1.113883.2.4.15.111"/> <assignedPrincipalChoiceList> <assignedPerson> <name xsi:type="PN"> <given partType="GIV" qualifier="IN">R.</given> <family partType="FAM" qualifier="BR">Rip</family> </name> </assignedPerson> </assignedPrincipalChoiceList> <Organization> <id root="2.16.528.1.1007.3.3" extension="00000509"/> <code code="JGZ" codeSystem="2.16.840.1.113883.2.4.15.1060"/> <name>JGZ Kennemerland</name> <addr> <city>Amsterdam</city> </addr> </Organization> </assignedEntity> </overseer>

hl7:assignedEntity

1 .. 1

Persoonsgegevens

(OpvragenVaccinatiestatus)

hl7:id

II.NL.UZI

1 .. 1

Zorgverlener-id

(OpvragenVaccinatiestatus)

@root

1 .. 1

2.16.528.1.1007.3.1

hl7:code

1 .. 1

Zorgverlener-code

(OpvragenVaccinatiestatus)

Schematron assert role error

test @codeSystem='2.16.840.1.113883.2.4.15.111' and not(@code='00.000')

Melding Control Act: <name path=".."/>/<name/> moet een UZI-register rolcode bevatten en deze mag niet 00.000 zijn

hl7:assignedPrincipalChoiceList

1 .. 1

(OpvragenVaccinatiestatus)

hl7:assignedPerson

1 .. 1

Persoonsgegevens

(OpvragenVaccinatiestatus)

hl7:name

1 .. 1

Zorgverlener-naam

(OpvragenVaccinatiestatus)

hl7:Organization

1 .. 1

Organisatiegegevens

(OpvragenVaccinatiestatus)

hl7:id

1 .. 1

Organisatie-id

(OpvragenVaccinatiestatus)

Schematron assert role error

test @root='2.16.528.1.1007.3.3' and @extension

Melding Control Act: <name path=".."/>/<name/> moet een URA bevatten

hl7:code

0 .. 1

Organisatietype. Geldige waarden komen uit RoleCodeNL - zorgaanbiedertype (2.16.840.1.113883.2.4.15.1060)

(OpvragenVaccinatiestatus)

@codeSystem

1 .. 1

2.16.840.1.113883.2.4.15.1060 (RoleCodeNLUZIRoleCodeOrganisaties)

hl7:name

1 .. 1

Organisatie-naam

(OpvragenVaccinatiestatus)

hl7:addr

1 .. 1

Organisatie-adres

(OpvragenVaccinatiestatus)

Schematron assert role error

test hl7:city

Melding Control Act: <name path=".."/>/<name/> moet tenminste de vestigingsplaats bevatten

Template Opvragen vaccinatiestatus (interactie)