HL7 Immunization User Group
Monthly Meeting February 13, 2020 2:00 PM ET
HL7 Immunization User Group Monthly Meeting February 13, 2020 - - PowerPoint PPT Presentation
HL7 Immunization User Group Monthly Meeting February 13, 2020 2:00 PM ET Agenda Welcome - Which perspective do you primarily identify yourself with? Updates SISC FHIR Five on FHIR Error Code Review Review of Guidance
Monthly Meeting February 13, 2020 2:00 PM ET
Heather Patrick
Nathan Bunker
Nathan Bunker
Tracy Little
Developed following publication of the HL7 2.5.1 rel. 1.5 IG The ERR segment is used to exchange error related data:
message.
(communication) error.
informational, a warning or an error.
error that occurred.
the nature of the error. Companion spreadsheet: Compiled Error Codes
sets: HL70357 and HL70533
format or technical type errors. This table is “HL7 Defined” and cannot be amended or expanded.
for clinical or administrative type errors related to data reported. This table is a “User Defined” HL7 table and can be expanded.
ional S Set of
Error Cod Codes
mpiled E Error Codes
Repository keywords: error codes
updating/expanding your system’s use of application error codes, start here. Leverage what has already been added if it meets your needs.
Codes are categorized by class
Release 1.5)
message is internally inconsistent)
found based on data in the message)
based on local business rules)
Guida idance ce f for
HL7 A ACK CK Messages to Support I Interoperabilit ility
Repository keyword: ACK
Kevin Snow
Harmonizing HL7 Validation with the AIRA Data Validation Guide and National Error Code Set Guidance
Jan 2019 Feb 2020
Completeness Consistency Accuracy Timeliness Validity
Who
What
Where • HL7 Response Messages When • In real time Why
How
https://immregistries.org/resource/
High Priority accuracy validation
HL7 Data Quality Statement AIRA-DV-BR-101: RXA-3 (DateTimeStartOfAdministration) must not be before PID-7 (DateTimeOfBirth) when RXA-21 (ActionCode) is not valued "D“. When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 2204^Vaccination Date Too Long Ago^HL70533
Submit a vaccine the day before the DOB MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000||VXU^V04^VXU_V04|KS99 9938854000000232|T|2.5.1|||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|19981231||45^hep B, unspec^CVX|999|||01^historical^NIP001||^^^KS9999|||||||||CP|A Should yield ERR||RXA^1^3^1^1|999^ApplicationError^HL70357|E|2204^Vaccination Date Too Long Ago^HL70533^AIRA-DV-BR-101^Vaccination Encounter Date must not be before Patient Date of Birth^L||NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: 148, ApplicationErrorCode: AIRA-DV- BR-101, AIRA Data Validation Guide Rule: BR 101|RXA-3 (DateTimeStartOfAdministration): must not be before PID-7 (DateTimeOfBirth) when RXA-21 (ActionCode) is not valued "D". Please see BR-101 in the AIRA Data Validation Guide.
High Priority accuracy validation
HL7 Data Quality Statement AIRA-DV-BR-103: RXA-3 (DateTimeStartOfAdministration) must be less than or equal to (before or the same as) MSH-7 (DateTimeOfMessage) when RXA-21 (ActionCode) is not valued "D". When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 1^Illogical Date error^HL70533
Submit the following MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000||VXU^V04^VXU _V04|KS999938854000000232|T|2.5.1|||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|20291231||45^hep B, unspec^CVX|999|||01^historical^NIP001||^^^KS9999|||||||||CP|A And you should see the following somewhere in the response ERR||RXA^1^3^1^1|999^ApplicationError^HL70357|E|1^Illogical Date error^HL70533^AIRA-DV-BR-103^Vaccination Encounter Date must be less than or equal to (before or the same as) the Submission Date^L||NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: 73, ApplicationErrorCode: AIRA-DV-BR-103, AIRA Data Validation Guide Rule: BR 103|RXA- 3 (DateTimeStartOfAdministration): must be less than or equal to (before or the same as) MSH-7 (DateTimeOfMessage) when RXA-21 (ActionCode) is not valued "D". Please see BR-103 in the AIRA Data Validation Guide.
High Priority accuracy validation
Not Implemented Was unsure how to implement due to:
High Priority accuracy validation
BR-114: Vaccination Encounter Date should not be the same as the Patient Date of Birth unless it is on the list of vaccines recommended for administration on the date of birth, e.g., HepB
HL7 Data Quality Statement AIRA-DV-BR-114: RXA-3 (DateTimeStartOfAdministration) should not be the same as PID-7 (DateTimeOfBirth) unless it is on the list of vaccines recommended for administration on the date of birth, e.g., HepB when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D“. When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 1^Illogical Date error^HL70533
Case 1) A historic MMR given on the DOB should yield a Warning Step 1) Submit the following message MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000||VXU^V04^VXU_V04|KS999938854000000232|T|2.5.1|||ER |AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|19990101||03^MMR^CVX|999|||01^historical^NIP001||^^^KS9999|||||||||CP|A Step 2) Verify in the response message the presence of the following WARNING ERR||RXA^1^3^1^1|999^ApplicationError^HL70357|W|1^Illogical Date error^HL70533^AIRA-DV-BR-114^Vaccination Encounter Date should not be the same as the Patient Date of Birth for this Vaccine^L||NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: , ApplicationErrorCode: AIRA-DV-BR-114, AIRA Data Validation Guide Rule: BR 114|RXA-3 (DateTimeStartOfAdministration): should not be the same as PID-7 (DateTimeOfBirth) unless it is on the list of vaccines recommended for administration on the date of birth, e.g., HepB when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". Please see BR-114 in the AIRA Data Validation Guide.
High Priority accuracy validation
Not Implemented Was unsure how to implement due to:
the code change? Do we need history of this to allow multiple values? Is there a challenge with keeping this up to date?
Functional Guide Vol 2-Review Draft 1.7.19.docx
High Priority accuracy validation
HL7 Data Quality Statement AIRA-DV-BR-118: RXA-3 (DateTimeStartOfAdministration) should not be after RXA-16 (SubstanceExpirationDate) when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 2001^Conflicting Administration Date and Expiration Date^HL70533
Submit the following message MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000+0000||VXU^V04^VXU_V04|KS999938854000000232|T|2.5.1| ||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|19990101||08^Hep B, ped/adol^CVX|0.5|mL^^UCUM||00^New admin^NIP001|^Sticker^Nurse^^^^^^^^^^^^^^^^^^RN|^^^KS9999||||lotnum|19981231|SKB^GlaxoSmithKline^MVX|||CP|A RXR|C28161^Intramuscular^NCIT^IM^Intramuscular^HL70162|RT^Right Thigh^HL70163 OBX|1|CE|64994-7^Eligibility Status^LN|1|V02^Medicaid^HL70064||||||F|||19990101|||VXC40^vaccine level^CDCPHINVS OBX|2|CE|30963-3^Vaccine funding source^LN|2|VXC51^Public VFC^NIP008||||||F|||19990101 OBX|3|CE|30956-7^vaccine type^LN|3|45^Hep B, UF^CVX||||||F|||19990101 OBX|4|TS|29768-9^VIS Publication Date^LN|3|19970101||||||F|||19990101 OBX|5|TS|29769-7^VIS Presentation Date^LN|3|19990101||||||F|||19990101 And you should see the following warning in the response ERR||RXA^1^3^1^1|999^ApplicationError^HL70357|W|2001^Conflicting Administration Date and Expiration Date^HL70533^AIRA-DV- BR-118^Vaccination Encounter Date should not be after the lot number expiration date^L||NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: 147, ApplicationErrorCode: AIRA-DV-BR-118, AIRA Data Validation Guide Rule: BR 118|RXA-3 (DateTimeStartOfAdministration): should not be after the lot number expiration date
Medium Priority accuracy validation
HL7 Data Quality Statement AIRA-DV-BR-119: RXR-1 (Route) and RXR-2 (AdministrationSite) contradict each other for the given Vaccine Type in RXA-5 (AdministeredCode) and Patient’s age on RXA-3 (DateTimeStartOfAdministration) when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 3^Illogical Value error^HL70533
MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000+0000||VXU^V04^VXU_V04|KS999938854000000232|T|2.5.1| ||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|19990101||08^Hep B, ped/adol^CVX|0.5|mL^^UCUM||00^New admin^NIP001|^Sticker^Nurse^^^^^^^^^^^^^^^^^^RN|^^^KS9999||||lotnum|20000101|SKB^GlaxoSmithKline^MVX|||CP|A RXR|C28161^Intramuscular^NCIT^IM^Intramuscular^HL70162|LLFA^Left Lower Forearm^HL70163 OBX|1|CE|64994-7^Eligibility Status^LN|1|V02^Medicaid^HL70064||||||F|||19990101|||VXC40^vaccine level^CDCPHINVS OBX|2|CE|30963-3^Vaccine funding source^LN|2|VXC51^Public VFC^NIP008||||||F|||19990101 OBX|3|CE|30956-7^vaccine type^LN|3|45^Hep B, UF^CVX||||||F|||19990101 OBX|4|TS|29768-9^VIS Publication Date^LN|3|19970101||||||F|||19990101 OBX|5|TS|29769-7^VIS Presentation Date^LN|3|19990101||||||F|||19990101 Should yield ERR||RXR^1|999^ApplicationError^HL70357|W|3^Illogical Value error^HL70533^AIRA-DV-BR-119^Route and Site contradiction^L||NumericPath: RXR[1], NamePath: ORDER[0]/RXR, RuleId: , ApplicationErrorCode: AIRA-DV-BR-119, AIRA Data Validation Guide Rule: BR 119|RXR-1 (Route) and RXR-2 (AdministrationSite) contradict each other for the given Vaccine Type in RXA-5 (AdministeredCode) and Patient’s age on RXA-3 (DateTimeStartOfAdministration) when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". Please see BR-119 in the AIRA Data Validation Guide.
High Priority accuracy validation
BR-121: Administered vaccinations coded with an “unspecified” CVX code (should have specific Vaccine Types, e.g., Hib PRP-OMP; unspecified vaccine types, e.g., Hib, unspecified formulation)
HL7 Data Quality Statement AIRA-DV-BR-121: RXA-5 (AdministeredCode) should not be valued with an “unspecified” vaccine when the first occurrence of RXA-9.1 is valued "00" and RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". When the above data quality statement is violated then return ERR-3 (HL7ErrorCode) 3^Illogical Value error^HL70533
MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000+0000||VXU^V04^VXU_V04|KS999938854000000232|T|2.5.1|||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR~111111111^^^KS9999^SS||SIMPSON^BART^M^^^^L||19990101|M ORC|RE||9999^KS0000 RXA|0|1|19990101||45^Hep B, UF^CVX|0.5|mL^^UCUM||00^New admin^NIP001|^Sticker^Nurse^^^^^^^^^^^^^^^^^^RN|^^^KS9999||||lotnum|20000101|SKB^GlaxoSmithKline^MVX|||CP|A RXR|C28161^Intramuscular^NCIT^IM^Intramuscular^HL70162|RT^Right Thigh^HL70163 OBX|1|CE|64994-7^Eligibility Status^LN|1|V02^Medicaid^HL70064||||||F|||19990101|||VXC40^vaccine level^CDCPHINVS OBX|2|CE|30963-3^Vaccine funding source^LN|2|VXC51^Public VFC^NIP008||||||F|||19990101 OBX|3|CE|30956-7^vaccine type^LN|3|45^Hep B, UF^CVX||||||F|||19990101 OBX|4|TS|29768-9^VIS Publication Date^LN|3|19970101||||||F|||19990101 OBX|5|TS|29769-7^VIS Presentation Date^LN|3|19990101||||||F|||19990101 Should yield ERR||RXA^1^5^1|999^ApplicationError^HL70357|W|3^Illogical Value error^HL70533^AIRA-DV-BR-121^Administered vaccinations coded with an “unspecified” CVX code^L||NumericPath: RXA[1].5[1], NamePath: ORDER[0]/RXA/AdministeredCode, RuleId: 149, ApplicationErrorCode: AIRA-DV-BR-121, AIRA Data Validation Guide Rule: BR 121|RXA-5 (AdministeredCode): should not be valued with an “unspecified” vaccine when the first occurrence of RXA-9.1 is valued "00" and RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". Please see BR-121 in the AIRA Data Validation Guide.
High Priority accuracy validation
BR-130: Doses should not be recorded as given before the minimum patient age or after the maximum patient age for that particular vaccine
HL7 Data Quality Statement AIRA-DV-BR-130: Patient's age on RXA-3 (DateTimeStartOfAdministration) should not be before the minimum patient age or after the maximum patient age for the given Vaccine Type in RXA-5 (AdministeredCode) when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". When the above data quality statement is violated then return Next slide…
1) Hep A given at 9 months of age MSH|^~\&|TestApplication|KS9999|WebIZ|KS0000|20060201000000||VXU^V04^VXU_V04|KS99993885400 0000232|T|2.5.1|||ER|AL|||||Z22^CDCPHINVS PID|1||000000002^^^KS9999^MR||SIMPSON^BART^M^^^^L||19990101|M|||1011 Winward^^Manhattan^KS^66502^^M||^PRN^^^^864^1309701| ORC|RE||9999^KS0000 RXA|0|1|19990901||85^Hep A, UF^CVX|999|||01^historical^NIP001||^^^KS9999|||||||||CP|A Should yield ERR||RXA^1^3^1^1|999^ApplicationError^HL70357|W|3^Illogical Value error^HL70533^AIRA-DV-BR- 130^Vaccine dose given before the minimum patient age or after the maximum patient age^L||NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: , ApplicationErrorCode: AIRA-DV-BR-130, AIRA Data Validation Guide Rule: BR 130, Minimum Date: 19991229, Administration Date: 19990901, Days Difference: 119|Doses should not be recorded as given before the minimum patient age or after the maximum patient age for that particular vaccine
ERR-3 (HL7ErrorCode) 3^Illogical Value error^HL70533 ERR-7 (DiagnosticInfor mation) NumericPath: RXA[1].3[1].1, NamePath: ORDER[0]/RXA/DateTimeStartOfAdministration/Time, RuleId: , ApplicationErrorCode: AIRA-DV-BR-130, AIRA Data Validation Guide Rule: BR 130, Maximum Date: 20180101, Administration Date: 20181217, Days Difference: 350 ERR-8 (UserMessage) RXA-3 (DateTimeStartOfAdministration): Patient's age on this date should not be before the minimum patient age or after the maximum patient age for the given Vaccine Type in RXA-5 (AdministeredCode) when RXA-20 (CompletionStatus) is valued "CP" or "PA" and RXA-21 (ActionCode) is not valued "D". Please see BR-130 in the AIRA Data Validation Guide. When the above data quality statement is violated then return
Nathan Bunker
New Content Area Nathan Bunker
42
Transport Submission / Acknowledgment Query / Response CDS Data Quality - Incoming/ongoing
Testing & Discovery Assessment Validation Testing & Discovery Assessment Validation Testing & Discovery Assessment Validation Testing & Discovery Assessment Testing & Discovery
Assessment
43
44
Submission & ACK Incoming & Ongoing Data Quality
Tests what messages the system said they accept/return, and if they’re conformant Tests what the system actually did with the messages…
45
submission to query without changing the meaning
records submitted with phone number)
46
Step 1
intentionally poor data
Invalid, or Conflicting Data Step 2
for patient Step 3
and RSP
47
TEST PASS
TEST FAIL OK
submit the record to the IIS.
and submit the record to the IIS.
per the HL7 Implementation guide, but the data within the message is illogical when compared against other data elements
51
level
to patient
52
53
Tracy Little
When generating an RSP message, the IIS should echo back the QPD segment received in the QBP query message. This is the patient demographic data sent by the querying system and it should be returned as it was sent. Other segments in the RSP (PID, PD1, NK1) should be populated with data from the responding system’s database. Querying systems may use this data to validate patient selection. Demographic data sent by the querying system in the QPD segment should not be used to populate the PID, PD1 or NK1 segments. The patient ID in QPD-3 should echo what was submitted in the query, but PID-3 can repeat so it can be populated with more than identifier including:
March 12, 2020 2:00 pm ET / 11:00 am PT
http://www.hl7.org/participate/UserGroups.cfm?UserGroup=Immunization
http://www.hl7.org/special/committees/iug/index.cfm
http://iugwiki.hl7.org/
http://www.hl7.org/documentcenter/public_temp_F760602A-1C23-BA17- 0C0D326E635471F9/pressreleases/HL7_PRESS_20140402.pdf
http://www.immregistries.org/events/2014/04/10/hl7-immunization-user-group
If you have any questions or comments:
Thank you!