Terug naar index << Terug naar templates

# Template Accept Acknowledgement

Id | 2.16.840.1.113883.2.4.3.11.60.102.10.0 ref hl7m- | Versie | 2014‑07‑15
Status | Actief | Versielabel |
Naam | MCCI_IN000002 | Weergavenaam | Accept Acknowledgement
Omschrijving
Een Accept Acknowledgement/Ontvangstbevestiging (MCCI_IN000002) vertelt of de interactie waarop wordt geantwoord succesvol is ontvangen, is afgeleverd bij de bedoelde applicatie, en of deze interactie syntactisch correct is bevonden. Het ontvangende systeem voert een technische validatie uit op de interactie. Technische validatie omvat alles wat een ontvangend systeem volledig automatisch, direct na ontvangst kan doen op het gebied van structuur en syntaxvalidatie. Hieronder valt: of de interactie ondersteund wordt op basis van interactie-id en profile-id; of de interactie is afgeleverd bij de applicatie die is geïdentificeerd in het element receiver in de transmission wrapper; of de interactie transmission wrapper ondersteunde waarden heeft voor `sender/device/id`, `processingCode`, `versionCode`, en `attentionLine`; of de interactie syntactisch correct is bevonden, waaronder; verplichte elementen en attributen aanwezig; verplichte herhaling van elementen aanwezig; geen elementen met een null waarde, die zijn gespecificeerd als mandatory; geen elementen of attributen die niet zijn gespecificeerd; geen herhaling van elementen die niet mogen herhalen; geen codesystemen (op plaatsen die) die niet zijn gespecificeerd; geen codes welke niet bestaan in het opgegeven codesysteem; De Accept Acknowledgement bestaat uit een specialisatie van de Transmission Wrapper en bevat geen Trigger Event Control Act (klasse ControlActProcess) en bevat geen payload. FAQ: Wanneer dient een ontvangend systeem een ontvangstbevestiging te versturen? – De implementatiespecificatie bepaalt van tevoren welke communicatiepatronen zijn toegestaan. De ontvanger kan dus op deze plaats lezen of er sprake is van een ontvangstbevestiging of van een applicatie-antwoord. Als de zender een ontvangstbevestiging mag verwachten dan zal hij dat kenbaar maken door in het attribuut Message.`acceptAckCode` de waarde "AL" (Always) opgeven. De berichtontvanger dient in dat geval altijd een ontvangstbevestiging te retourneren. Als de zender een applicatieantwoord mag verwachten dan zal hij dat kenbaar maken door in het attribuut Message.`acceptAckCode` de waarde "NE" (Never) opgeven. De berichtontvanger dient in dat geval atijd een inhoudelijk antwoord te retourneren. Op dit moment wordt op het LSP geen gebruik gemaakt van de waarde "ER" (Error only).
Context | Padnaam /
Classificatie | HL7v2/v3 message level template
Open/gesloten | Open (ook andere dan gedefinieerde elementen zijn toegestaan)
Gebruikt door / Gebruikt |
Gebruikt door 6 transacties en 0 templates, Gebruikt 1 template
Gebruikt door | als | Naam | Versie
--- | --- | --- | ---
jgz-transactions-58 | Transactie | Ontvangstbevestiging JGZ-dossieroverdrachtverzoek v04 (420) | 2024‑11‑01
jgz-transactions-46 | Transactie | Ontvangstbevestiging geldige partijunmmers (402) | 2020‑05‑27
jgz-transactions-49 | Transactie | Ontvangstbevestiging vaccinaties (402) | 2020‑05‑27
jgz-transactions-52 | Transactie | Ontvangstbevestiging geanonimiseerde vaccinaties (402) | 2020‑05‑27
jgz-transactions-55 | Transactie | Ontvangstbevestiging vaccinatiesoproeplijst (402) | 2020‑05‑27
jgz-transactions-40 | Transactie | Ontvangstbevestiging hielprikverzoek (402) | 2020‑05‑27
Gebruikt | als | Naam | Versie
2.16.840.1.113883.2.4.3.11.60.102.10.200 | Inclusie | TransmissionWrapper Accept Ack | 2014‑07‑15
XML overzicht |
XML overzicht
Scenario | Transactie | Transactie |
--- | --- | --- | ---
DOB - Dossieroverdracht 420 | Versturen dossieroverdrachtverzoek v04 420 | Ontvangstbevestiging JGZ-dossieroverdrachtverzoek v04 420 | HTML (Transactie) HTML (Dataset) XML
RVP - Rijksvaccinatieprogramma - BDS 4.1.3 413 | Versturen geldige partijnummers 402 | Ontvangstbevestiging geldige partijunmmers 402 | HTML (Transactie) HTML (Dataset) XML
RVP - Rijksvaccinatieprogramma - BDS 4.1.3 413 | Versturen vaccinaties 413 | Ontvangstbevestiging vaccinaties 402 | HTML (Transactie) HTML (Dataset) XML
RVP - Rijksvaccinatieprogramma - BDS 4.1.3 413 | Versturen geanonimiseerde vaccinaties 413 | Ontvangstbevestiging geanonimiseerde vaccinaties 402 | HTML (Transactie) HTML (Dataset) XML
RVP - Rijksvaccinatieprogramma - BDS 4.1.3 413 | Versturen vaccinatiesoproeplijst 402 | Ontvangstbevestiging vaccinatiesoproeplijst 402 | HTML (Transactie) HTML (Dataset) XML
NHS - Neonatale hielprikscreening - BDS 4.1.3 402 | Versturen hielprikverzoek 402 | Ontvangstbevestiging hielprikverzoek 402 | HTML (Transactie) HTML (Dataset) XML
Item | DT | Card | Conf | Omschrijving | Label
--- | --- | --- | --- | --- | ---
hl7:MCCI_IN000002 |  | 1 … 1 | M |  |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.200 TransmissionWrapper Accept Ack (2014‑07‑15)
hl7:id | II | 1 … 1 | M | Bericht-id |
@root | uid | 1 … 1 | R |
@extension | st | 1 … 1 | R |
hl7:creationTime | TS.DATETIME.MIN | 1 … 1 | M | Bericht-aanmaakdatum/tijd |
| Constraint | creationTime moet minimaal op de seconde nauwkeurig zijn
hl7:versionCode | CS | 1 … 1 | M | Bericht-versiecode |
@code | CONF | 1 … 1 | F | NICTIZEd2005-Okt
hl7:interactionId | II | 1 … 1 | M | Bericht-interactie-id |
@root | uid | 1 … 1 | F | 2.16.840.1.113883.1.6
| 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 | II | 1 … 1 | M | Bericht-profile-id |
@root | uid | 1 … 1 | F | 2.16.840.1.113883.2.4.3.11.1
@extension | st | 1 … 1 | F | 810
hl7:processingCode | CS | 1 … 1 | M | Bericht-verwerkingsmodus |
@code | CONF | 1 … 1 | F | P
hl7:processingModeCode | CS | 1 … 1 | M | Bericht-verwerkingsmodus |
@code | CONF | 1 … 1 | F | T
hl7:acceptAckCode | CS | 1 … 1 | M | Indicatie of de zender een technische ontvangstbevestiging wil krijgen. |
@code | CONF | 1 … 1 | F | NE
hl7:acknowledgement |  | 1 … 1 | M | Details van de bevestiging |
@typeCode | cs | 1 … 1 | R |
| CONF |
De waarde van @typeCode MOET komen uit waardelijst 2.16.840.1.113883.1.11.8 AcknowledgementType (2011‑07‑26)
| Voorbeeld | <acknowledgement typeCode="CA"> <targetMessage> <id extension="200103" root="2.16.528.1.1007.3.3.112233.1"/> </targetMessage></acknowledgement>
hl7:acknowledgementDetail |  | 0 … * | C | Bevat foutmeldingen |
@typeCode | cs | 0 … 1 |  |
| CONF |
De waarde van @typeCode MOET komen uit waardelijst 2.16.840.1.113883.1.11.19358 AcknowledgementDetailType (2011‑07‑26)
| Constraint | Relevant indien ../../acknowledgement/@typeCode niet CA of AA is
hl7:code | CV | 1 … 1 | M | Foutcode |
| Schematron assert | role | error |
| test | @codeSystem = '2.16.840.1.113883.5.1100' or @displayName |
| Melding | @displayName is verplicht als de code niet uit de valueset AcknowledgementDetailCode komt |
hl7:text | ST | 0 … 1 |  | Fouttext |
hl7:location | ST | 0 … * |  | Foutlocatie. Kan bijvoorbeeld een XPath-expressie zijn waar de fout optrad |
| Schematron assert | role | error |
| test | not(@typeCode) or @typeCode = 'E' |
| Melding | @typeCode is optioneel aanwezig, maar moet indien aanwezig de waarde “E” bevatten. |
hl7:targetMessage |  | 1 … 1 | M | Bevat de referentiedetails van het bericht waarop wordt geantwoord |
hl7:id | II | 1 … 1 | M | Identificatie van het bericht waarop wordt geantwoord |
| Schematron assert | role | error |
| test | substring(@typeCode, 1, 1) = 'C' |
| Melding | De acknowledgement typeCode kan alleen een code zijn beginnend met een 'C' |
| Schematron assert | role | error |
| test | @typeCode != 'CE' or hl7:acknowledgementDetail |
| Melding | Indien er in het bericht een fout wordt opgegeven, dan dient ook de volledige fout te worden aangegeven met een foutcode en foutmelding |
Inclusie | 0 … * |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.120 TransmissionWrapper AttentionLine (2014‑07‑15)
hl7:attentionLine |  | 0 … * |  | Bevat gegevens met een bepaalde attentiewaarde |
hl7:keyWordText | SC | 1 … 1 | M | Dit element functioneert als sleutel in een sleutel/waarde-paar en geeft betekenis aan de waarde in het element value. |
| CONF |
De waarde van @code MOET komen uit waardelijst 2.16.840.1.113883.2.4.3.11.60.102.11.1 AttentionLineElementTypeNL (DYNAMISCH)
hl7:value | ANY | 1 … 1 | M | Dit element functioneert als waarde bij de sleutel in het element keyWordText. Het datatype is niet van tevoren gedefinieerd en moet dus runtime via @xsi:type worden toegekend. |
jgz-bds-element-655 | BSN ouder/verzorger 400 | Basisdataset (BDS) 420
jgz-bds-element-7 | BSN 400 | Basisdataset (BDS) 420
@xsi:type |  | 1 … 1 | F | ANY
hl7:receiver |  | 1 … 1 | M |  |
@typeCode | cs | 0 … 1 | F | RCV
hl7:telecom | TEL | 0 … 1 |  | Bevat contactgegevens (meestal telefoonnummer) van de persoon of organisatie die verantwoordelijk is voor het beheer van de applicatie geïdentificeerd in de geassocieerde Device klasse. |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.110 TransmissionWrapper Device (2014‑07‑15)
hl7:device |  | 1 … 1 | M | Applicatiegegevens |
@determinerCode | cs | 0 … 1 | F | INSTANCE
| Bevat of het om een bepaald soort gaat, of één specifieke instantie van het klassetype.
@classCode | cs | 0 … 1 | F | DEV
| Bevat het klassetype
Inclusie | 1 … 1 | M | van 2.16.840.1.113883.2.4.3.11.60.102.10.1008 AORTA Application ID (2014‑07‑15) Applicatie-id
hl7:id | II | 1 … 1 | M | AORTA Applicatie-id |
@extension | st | 1 … 1 | R | Bevat het applicatie-id
@root | uid | 1 … 1 | F | 2.16.840.1.113883.2.4.6.6
hl7:name | EN | 0 … 1 |  | Applicatie-naam |
hl7:telecom | TEL | 0 … * |  | Bevat URL’s van de zendende/ontvangende applicatie, waaronder bijvoorbeeld de http of tcp/ip connectiegegevens. |
hl7:softwareName | SC | 0 … 1 |  | Softwarename: een tekstuele beschrijving van de gebruikte software, bijvoorbeeld “X-ZIS versie 7.2”. |
hl7:agencyFor |  | 0 … 1 |  | Met organisatie wordt dat organisatie(deel) bedoeld dat in juridische zin verantwoordelijk is voor het transport (de fysieke verzending) van een bericht of de ontvangst daarvan, bijvoorbeeld een apotheek of ziekenhuis. Voorbeelden: Indien de zender van een bericht een huisartssysteem is, dan bevat device.id de identificatie van het huisartssysteem, en representedOrganization.id de identificatie van de huisartsenpraktijk. De huisartsenpraktijk is de organisatie verantwoordelijk voor het transport van het bericht. Indien de zender van een bericht een laboratoriummodule binnen het ZIS is, dan bevat device.id de identificatie van de laboratoriummodule. Indien het ZIS de communicatie (de transportverantwoordelijkheid) verricht namens de laboratoriummodule, bevat representedOrganization.id de identificatie van het Ziekenhuis, zijnde de verantwoordelijke organisatie voor het ZIS. |
@classCode | cs | 0 … 1 | F | AGNT
hl7:representedOrganization |  | 0 … 1 |  | Bevat de gegevens van de betreffende organisatie. |
@classCode | cs | 0 … 1 | F | ORG
@determinerCode | cs | 0 … 1 | F | INSTANCE
hl7:id | II | 1 … 1 | M | Organisatie-id |
hl7:name | ON | 0 … * |  | Organisatie-naam |
hl7:telecom | TEL | 0 … * |  | Organisatie-telecom |
hl7:NotificationParty |  | 0 … 1 |  |  |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.516 Notification Party [contact] (2012‑09‑01)
@classCode |  | 0 … 1 | F | CON
hl7:id | II | 0 … * |  |  |
hl7:code | CE | 0 … * |  |  |
hl7:addr | AD | 0 … * |  |  |
hl7:telecom | TEL | 0 … * |  |  |
hl7:contactParty |  | 1 … 1 |  |  |
Keuze | 1 … 1 |  | Elementen om uit te kiezen: hl7:Organization met template 2.16.840.1.113883.2.4.3.11.60.102.10.517 Organization [contact] (2012‑09‑01) hl7:Person met template 2.16.840.1.113883.2.4.3.11.60.102.10.518 Person [contact] (2012‑09‑01)
hl7:Organization |  | … 1 |  | Bevat 2.16.840.1.113883.2.4.3.11.60.102.10.517 Organization [contact] (2012‑09‑01) |
hl7:Person |  | … 1 |  | Bevat 2.16.840.1.113883.2.4.3.11.60.102.10.518 Person [contact] (2012‑09‑01) |
hl7:sender |  | 1 … 1 | M |  |
@typeCode | cs | 0 … 1 | F | SND
hl7:telecom | TEL | 0 … 1 |  | Bevat contactgegevens (meestal telefoonnummer) van de persoon of organisatie die verantwoordelijk is voor het beheer van de applicatie geïdentificeerd in de geassocieerde Device klasse. |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.110 TransmissionWrapper Device (2014‑07‑15)
hl7:device |  | 1 … 1 | M | Applicatiegegevens |
@determinerCode | cs | 0 … 1 | F | INSTANCE
| Bevat of het om een bepaald soort gaat, of één specifieke instantie van het klassetype.
@classCode | cs | 0 … 1 | F | DEV
| Bevat het klassetype
Inclusie | 1 … 1 | M | van 2.16.840.1.113883.2.4.3.11.60.102.10.1008 AORTA Application ID (2014‑07‑15) Applicatie-id
hl7:id | II | 1 … 1 | M | AORTA Applicatie-id |
@extension | st | 1 … 1 | R | Bevat het applicatie-id
@root | uid | 1 … 1 | F | 2.16.840.1.113883.2.4.6.6
hl7:name | EN | 0 … 1 |  | Applicatie-naam |
hl7:telecom | TEL | 0 … * |  | Bevat URL’s van de zendende/ontvangende applicatie, waaronder bijvoorbeeld de http of tcp/ip connectiegegevens. |
hl7:softwareName | SC | 0 … 1 |  | Softwarename: een tekstuele beschrijving van de gebruikte software, bijvoorbeeld “X-ZIS versie 7.2”. |
hl7:agencyFor |  | 0 … 1 |  | Met organisatie wordt dat organisatie(deel) bedoeld dat in juridische zin verantwoordelijk is voor het transport (de fysieke verzending) van een bericht of de ontvangst daarvan, bijvoorbeeld een apotheek of ziekenhuis. Voorbeelden: Indien de zender van een bericht een huisartssysteem is, dan bevat device.id de identificatie van het huisartssysteem, en representedOrganization.id de identificatie van de huisartsenpraktijk. De huisartsenpraktijk is de organisatie verantwoordelijk voor het transport van het bericht. Indien de zender van een bericht een laboratoriummodule binnen het ZIS is, dan bevat device.id de identificatie van de laboratoriummodule. Indien het ZIS de communicatie (de transportverantwoordelijkheid) verricht namens de laboratoriummodule, bevat representedOrganization.id de identificatie van het Ziekenhuis, zijnde de verantwoordelijke organisatie voor het ZIS. |
@classCode | cs | 0 … 1 | F | AGNT
hl7:representedOrganization |  | 0 … 1 |  | Bevat de gegevens van de betreffende organisatie. |
@classCode | cs | 0 … 1 | F | ORG
@determinerCode | cs | 0 … 1 | F | INSTANCE
hl7:id | II | 1 … 1 | M | Organisatie-id |
hl7:name | ON | 0 … * |  | Organisatie-naam |
hl7:telecom | TEL | 0 … * |  | Organisatie-telecom |
hl7:NotificationParty |  | 0 … 1 |  |  |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.516 Notification Party [contact] (2012‑09‑01)
@classCode |  | 0 … 1 | F | CON
hl7:id | II | 0 … * |  |  |
hl7:code | CE | 0 … * |  |  |
hl7:addr | AD | 0 … * |  |  |
hl7:telecom | TEL | 0 … * |  |  |
hl7:contactParty |  | 1 … 1 |  |  |
Keuze | 1 … 1 |  | Elementen om uit te kiezen: hl7:Organization met template 2.16.840.1.113883.2.4.3.11.60.102.10.517 Organization [contact] (2012‑09‑01) hl7:Person met template 2.16.840.1.113883.2.4.3.11.60.102.10.518 Person [contact] (2012‑09‑01)
hl7:Organization |  | … 1 |  | Bevat 2.16.840.1.113883.2.4.3.11.60.102.10.517 Organization [contact] (2012‑09‑01) |
hl7:Person |  | … 1 |  | Bevat 2.16.840.1.113883.2.4.3.11.60.102.10.518 Person [contact] (2012‑09‑01) |
Inclusie |  |  | van 2.16.840.1.113883.2.4.3.11.60.102.10.101 Generic Transmission Checks (2014‑07‑15)
| Variabele let | Naam | transmission |
| Waarde | . |
| Variabele let | Naam | interactionId |
| Waarde | $transmission/local-name() |
| Variabele let | Naam | interactionVocabFile |
| Waarde | '../vocab/2.16.840.1.113883.1.6.xml' |
| Variabele let | Naam | interactionVocab |
| Waarde | if (doc-available($interactionVocabFile)) then doc($interactionVocabFile) else () |
| Variabele let | Naam | interactionName |
| Waarde | $interactionVocab/*/hl7:code[@code=$interactionId]/@displayName |
| Variabele let | Naam | isActive |
| Waarde | not(exists($interactionVocab/*/hl7:code[@code=$interactionId]/hl7:qualifier[@name='Actief'][@value='false'])) |
| Variabele let | Naam | allowBsn |
| Waarde | exists($interactionVocab/*/hl7:code[@code=$interactionId]/hl7:qualifier[@name='AttentionLineMetBsn'][@value='true']) |
| Variabele let | Naam | allowContextCode |
| Waarde | exists($interactionVocab/*/hl7:code[@code=$interactionId]/hl7:qualifier[@name='AttentionLineMetContextCode'][@value='true']) |
| Variabele let | Naam | senderGbpOrGbk |
| Waarde | exists($transmission/hl7:ControlActProcess/hl7:authorOrPerformer/hl7:participant/hl7:AssignedPerson/hl7:code[@codeSystem=('2.16.840.1.113883.2.4.3.11.8','2.16.840.1.113883.2.4.3.11.6')]) |
| Schematron assert | role | warning |
| test | $interactionVocab |
| Melding | Transmission: <value-of select="$interactionVocabFile"/> niet gevonden. Controles gebaseerd op dit externe configuratiebestand zijn gedeactiveerd. |
| Schematron assert | role | error |
| test | not($interactionVocab) or $isActive |
| Melding | Transmission: deze interactie <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) is niet (meer) Actief in <value-of select="$interactionVocabFile"/> |
| Schematron assert | role | error |
| test | not($interactionVocab) or not($allowBsn) or $transmission/hl7:attentionLine/hl7:keyWordText[@code=('FICID','PATID')][@codeSystem='2.16.840.1.113883.2.4.15.1'] |
| Melding | Transmission: er moet in deze interactie exact één AttentionLine met BSN zitten - <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) |
| Schematron assert | role | error |
| test | not($interactionVocab) or not($allowContextCode) or $transmission/hl7:attentionLine/hl7:keyWordText[@code='CONTEXT'][@codeSystem='2.16.840.1.113883.2.4.15.1'] |
| Melding | Transmission: er moet in deze interactie exact één AttentionLine met de ContextCode zitten - <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) |
| Schematron assert | role | warning |
| test | not($interactionVocab) or not($transmission/hl7:attentionLine/hl7:keywordText[@code=('FICID','PATID')][@codeSystem='2.16.840.1.113883.2.4.15.1']) or $allowBsn or $senderGbpOrGbk |
| Melding | Transmission: deze interactie <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) is niet geconfigureerd voor gebruik van het element <value-of select="local-name()"/> voor BSN in <value-of select="$interactionVocabFile"/> en afzender is niet GBK of GBP |
| Schematron assert | role | warning |
| test | not($interactionVocab) or not($transmission/hl7:attentionLine/hl7:keywordText[@code='CONTEXT'][@codeSystem='2.16.840.1.113883.2.4.15.1']) or $allowContextCode or $senderGbpOrGbk |
| Melding | Transmission: deze interactie <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) is niet geconfigureerd voor gebruik van het element <value-of select="local-name()"/> voor ContextCode in <value-of select="$interactionVocabFile"/> en afzender is niet GBK of GBP |
| Schematron assert | role | error |
| test | count($transmission/hl7:attentionLine/hl7:keyWordText[@code=('FICID','PATID')][@codeSystem='2.16.840.1.113883.2.4.15.1'])<=1 |
| Melding | Transmission: er mag maximaal één AttentionLine met BSN zijn - <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) |
| Schematron assert | role | error |
| test | count($transmission/hl7:attentionLine/hl7:keyWordText[@code='CONTEXT'][@codeSystem='2.16.840.1.113883.2.4.15.1'])<=1 |
| Melding | Transmission: er mag maximaal één AttentionLine met de ContextCode zijn - <value-of select="$interactionId"/> (<value-of select="$interactionName"/>) |