Template 2.16.840.1.113883.2.4.3.111.3.12.10.21

Template QueryByParameter MP VZVZ Voorschrift

2.16.840.1.113883.2.4.3.111.3.12.10.21

ref

opv-vzvz-

Geldigheid

2017‑06‑16 08:55:11

Status Ontwerp Versielabel

Naam QueryByParMPVoorschrift-vzvz Weergavenaam QueryByParameter MP VZVZ Voorschrift

Omschrijving

FAQ: Welke parameters zijn bestemd voor gebruik door ZIM ten behoeve van efficiënt routeren van indirecte vraagberichten? – "Patiënt-id", "Actualiteit", "Beheerverantwoordelijke"en eventueel een "Gegevenssoort" code die specifieker is dan welke afleidbaar is uit het interactie-id. Een toepassing dient te specificeren welke van de door de toepassing gespecificeerde filterparameters mappen op deze concepten. In het verleden zijn er geen afspraken gemaakt over filterparameternaamgeving en zijn ook vaak internationaal geaccepteerde vraagberichten overgenomen. Dat maakt generieke interpretatie door de ontvanger lastiger. Nieuwe vraagberichten moeten zich aan de volgende conventie houden, waarbij geldt dat het vraagbericht niet noodzakelijk alle vraagparameters moet ondersteunen: er mag echter geen vraagparameter zijn met dezelfde functie als een van de onderstaande vraagparameters, maar onder een andere naam. Internationale vraagberichten moeten worden aangepast op deze lijst alvorens ze binnen Nederland toe te passen:

actId – voor een filterparameter op basis van Act-id met datatype II. Het Act-id is de identificatie van het gegeven in de verwijsindex en bij het beherende systeem. Het Act-id wordt toegekend in het XIS waar het gegeven ontstaat;
actReferenceCreationTime – voor een filterparameter op basis van gegevens met een aanmaaktijd binnen de opgegeven periode, los van de actualiteit in VWI. Gegevens met een aanmaaktijd in GBZ binnen de opgegeven periode worden opgeleverd. Merk op dat ZIM hier alleen op kan filteren indien de aanmaaktijd van het gegeven is geregistreerd in de VWI. Datatype is IVL<TS>;
actReferenceLastUpdateTime – voor een filterparameter op basis van gegevens die zijn gewijzigd binnen de opgegeven periode, los van de actualiteit VWI. Indexgegevens met een laatste bijwerktijd GBZ binnen de opgegeven periode worden opgeleverd. Merk op dat ZIM hier alleen op kan filteren indien de aanmaaktijd van het gegeven is geregistreerd in de VWI. Datatype is IVL<TS>;
authorId - voor een filterparameter op basis van Author-id met datatype II. Het gaat hier om de auteur/inhoudverantwoordelijke van het gegeven. Auteurs worden normalerwijs geïdentificeerd met hun UZI-nummer (OID: 2.16.528.1.1007.3.1);
authorRoleCode - voor een filterparameter op basis van Author-role code met datatype CV. Het gaat hier om de UZI-rolcode (OID: 2.16.840.1.113883.2.4.15.111) van de auteur/inhoudverantwoordelijke van het gegeven;
patientId – voor een filterparameter op basis van Patiënt-id met datatype II. Patiënten worden normalerwijs geïdentificeerd met hun burgerservicenummer (OID: 2.16.840.1.113883.2.4.6.3);
custodianApplicationId – voor een filterparameter op basis van Beherende-applicatie-id met datatype II. Beherende applicaties zijn normalerwijs AORTA-applicaties (OID: 2.16.840.1.113883.2.4.6.6);
custodianId – voor een filterparameter op basis van Beherende-zorgverlener-id met datatype II. Het gaat hier om de beheerverantwoordelijke persoon voor het gegeven. Beheerverantwoordelijken worden normalerwijs geïdentificeerd met hun UZI-nummer (OID: 2.16.528.1.1007.3.1);
custodianOrganizationId – voor een filterparameter op basis van Beherende-organisatie-id met datatype II. Het gaat hier om de beheerverantwoordelijke organisatie voor het gegeven. Organisaties worden normalerwijs geïdentificeerd met hun UZI-registerabonneenummer (OID:2.16.528.1.1007.3.3): als andere organisatietypen ook bronsysteem kunnen zijn voor bepaalde gegevens dan worden er ook andere typen identificatie van toepassing;
registrationProcessCreationTime – voor een filterparameter op basis van indexgegevens die zijn aangemeld binnen de opgegeven periode, los van de actualiteit van de indexgegevens zelf. Indexgegevens met een eerste aanmelddatum in VWI binnen de opgegeven periode worden opgeleverd. Datatype is IVL<TS>;
registrationProcessLastUpdateTime – voor een filterparameter op basis van indexgegevens die zijn gewijzigd binnen de opgegeven periode, los van de actualiteit van de indexgegevens zelf. Indexgegevens met een laatste bijwerktijd in VWI binnen de opgegeven periode worden opgeleverd. Datatype is IVL<TS>;
registrationProcessActCode – voor een filterparameter op basis van Gegevenssoort met datatype CV. Gegevenssoorten komen uit valueset ActRegistryCode: x_DataDomainNL waarin codes uit verschillende codesystemen voorkomen.

Meerdere parameter-elementen moeten worden verwerkt als logische AND terwijl meerdere value elementen binnen een parameter moeten worden verwerkt als een logische OR.

Classificatie HL7v3 Payload level template

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

Gebruikt door / Gebruikt

Gebruikt door 0 transacties en 2 templates, Gebruikt 1 template

Relatie Adaptatie: template 2.16.840.1.113883.2.4.3.11.60.20.77.10.9045 (2015‑07‑15 21:27:42)
Specialisatie: template 2.16.840.1.113883.2.4.3.11.60.102.10.505 (2012‑09‑01)

Voorbeeld

<queryByParameter> <queryId extension="extdummy" root="1.2.3.4.5"/> <statusCode code="executing"/> <responseModalityCode code="B"/> <responsePriorityCode code="I"/> <executionAndDeliveryTime value="20130102100000"/> <patientId> <value extension="123456782" root="2.16.840.1.113883.2.4.6.3"/> </patientId>   </queryByParameter>

Item DT Card Conf Omschrijving Label

hl7:queryByParameter Bevat de kenmerken van de vraag (Quezvz)

Schematron assert role warning

test not(.//hl7:semanticsText)

Melding Control Act: het element semanticsText onder queryparameters bij voorkeur niet gebruiken

Schematron assert role error

test not(hl7:sortControl)

Melding Control Act: queryByParameter/sortControl mag niet gebruikt worden

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. (Quezvz)

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.

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. (Quezvz)

Constraint @code moet bij initiële vragen de waarde "executing" bevatten.

CONF

De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.1.11.18899 QueryStatusCode (2011‑07‑26)

hl7:responseModalityCode CS 1 … 1 M Bevat code voor opleverwijze. Verplicht in AORTA met als mogelijkheden "gebundeld" (B - van toepassing bij indirect opvragen via de ZIM waarbij gebundeld moet worden opgeleverd), of "discreet" (R - van toepassing bij direct opvragen bij het bronsysteem, alle vragen van de ZIM bevatten deze opleverwijze.) (Quezvz)

Constraint

Indien de interactie van het type indirect opvragen is, en de interactie gaat van een GBx naar de ZIM, dan moet @code de waarde "B" bevatten.
Indien de interactie van het type indirect opvragen is, en de interactie gaat van ZIM naar een GBx, dan moet @code de waarde "R" bevatten.
Indien de interactie van het type direct opvragen is, dan moet @code de waarde "R" bevatten.

CONF

De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.1.11.394 ResponseModality (2011‑07‑26)

hl7:responsePriorityCode CS 1 … 1 M Bevat de code voor oplevertiming. De standaardwaarde is "I" (Immediate) voor synchrone, directe beantwoording. Merk op dat ook het tijdstip van beantwoording van de vraag in het vraagbericht zelf kan worden beïnvloed: zie de beschrijving van executionAndDeliveryTime. (Quezvz)

CONF

De waarde van @code moet komen uit waardelijst 2.16.840.1.113883.1.11.91 QueryPriority (2011‑07‑26)

hl7:executionAndDeliveryTime

0 … 1

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.

(Que

zvz)

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.

hl7:administrationRequestEffectiveTimeInterval 0 … 1 R Beoogde toedieningsperiode(s)
Verdere informatie (Quezvz)

Voorbeeld

Opvragen van de medicatievoorschriften waarvan de medicatie (voor zover dit is af te leiden uit het voorschrift) op 12 maart 2008 gebruikt werd (interval met breedte 1 dag).

<value> <low value="200803120000"/> <high value="200803122359"/></value>

Voorbeeld

Opvragen van de medicatievoorschriften waarvan de medicatie (voor zover dit is af te leiden uit het voorschrift) op of na een bepaalde datum gebruikt wordt (indien vandaag: ‘actuele medicatie’)

<value> <low value="201011190000"/></value>

hl7:value IVL_TS 1 … * M (Quezvz)

Keuze

1 … 2

Elementen om uit te kiezen:

hl7:low
hl7:high

hl7:low TS 0 … 1 R (Quezvz)

Schematron assert role error

test string-length(@value)>11 and substring(@value,9,4)='0000'

Melding Het is verplicht om bij de ondergrens de tijd 00:00 mee te geven.

hl7:high TS 0 … 1 R (Quezvz)

Schematron assert role error

test string-length(@value)>11 and substring(@value,9,4)='2359'

Melding Het is verplicht om bij de bovengrens de tijd 23:59 mee te geven.

Schematron assert role error

test not(exists(*[local-name()!='low' and local-name()!='high']))

Melding Alleen elementen low en/of high zijn toegestaan

hl7:medicationCombinedOrderID 0 … 1 R Voorschrift identificatie
Verdere informatie (Quezvz)

Voorbeeld

Opvragen van een specifiek medicatievoorschrift.

<value root="2.16.840.1.113883.2.4.6.1.6005432.2.8.1" extension="0012462311"/>

hl7:value II 1 … * M (Quezvz)

Inclusie 1 … 1 van 2.16.840.1.113883.2.4.3.11.60.102.10.1014 QueryParam PatientId (2014‑07‑15)

hl7:patientId 1 … 1 Bevat het burgerservicenummer van de patiënt/cliënt van wie de gegevens worden opgevraagd. (Quezvz)

hl7:value II.NL.BSN 1 … 1 M (Quezvz)

@root 1 … 1 F 2.16.840.1.113883.2.4.6.3

Template QueryByParameter MP VZVZ Voorschrift