PHC Hub logo  PHC Hub User Guide (v. July 2018)

Import Profile Issue Resolution Settings

Once a message is parsed, it is reviewed for potential data quality issues. Not every issue is necessarily a data quality issue. However, issues should be reviewed for each interface to determine how each issue should be handled. View the referenced code tables.

Use the following settings to define how to handle an issue:

Many issues can be assigned the following settings. These settings are not detailed in the table for each issue:

Use the following tabs to define the import profile issue resolution settings.

Patient Tab

Issue Resolution Name HL7 Field Description
Patient PID  

is eligible for VFC, but no guardian was submitted

  The patient's date of birth is less than 19 years with no guardians. Only when the patient has a valid guardian are the other issues raised.
Patient Gender PID-8  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the code value table.
Patient First Name PID-5.2  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

is truncated

  A name greater than 48 characters. Names greater than 48 characters do not fit in the database column.
Patient Last Name PID-5.1  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

is truncated

  A name greater than 48 characters. Names greater than 48 characters do not fit in the database column.
Patient Middle Name PID-5.3  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

is truncated

  A name greater than 48 characters. Names greater than 48 characters do not fit in the database column.

Patient Mother's Maiden Name

PID-6  

Patient Address Street

PID-11.1  

is invalid

  Considered invalid if one of these values: anywhere, nowhere, test1, test2, test3, address, address1, address2

Patient Address Street2

PID-11.2  

is invalid

  Considered invalid if one of these values: anywhere, nowhere, test1, test2, test3, address, address1, address2

Patient Address City

PID-11.3  

Patient Address Country

PID-11.6  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table. Two and three character code sets are accepted. Two character codes are returned for 2.3.1 and three for 2.5.1.

is unrecognized

  The code is not listed in the Country code value table.

Patient Address County

PID-11.9  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the County code value table.

Patient Address State

PID-11.4  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the State code value table.

Patient Address Zip

PID-11.5  

is invalid

  Considered invalid if:
  • Not 5 characters in length (all must be numeric)
  • Not 9 characters (all must be numeric)
  • Not 10 characters in length (and the 6th character is a "-")
  • Not a US zip code

Patient Alias

PID-9  

is missing

  No value is included.

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Patient Alias First

PID-9.2  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Patient Alias Last

PID-9.1  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Patient Alias Middle

PID-9.3  

is invalid

  Considered invalid if:
  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Patient Multiple Birth Indicator

PID-24  

is unrecognized

  The code is not recognized.

Patient Birth Order

PID-25  

is unrecognized

  The code is not recognized.

Birth Order and Birth Indicator are inconsistent

  Values are inconsistent if the Patient Multiple Birth Indicator is "N" and the Patient Birth Order is greater than 1. Any value less than or equal to 0 is considered unrecognized. Only recognized values are validated against the Birth Order and Multiple Birth Indicator.

Patient Death Date

PID-29  

is invalid

  The incoming value is a date that cannot be parsed because it is not in a format that is understood.

is in the future

  The date is in the future from the sent date.

is before the vaccination date

  The date is before the vaccination date.

is before the patient's date of birth

  The date is before the patient's date of birth.

Patient Medicaid Number

PID-3  

is invalid

  The value is less than 1 or more than 15.

Patient SSN

PID-3, PID-19  

is invalid

  Considered invalid if:
  • Contains characters other than 0-9
  • Is one of the following values: 987-65-4320, 987-65-4321, 123-45-6789

Patient Primary Language

PID-15  

is deprecated

  Not applicable at this time.

is unrecognized

  The code is not listed in the Language code value table.

Patient Phone Number

PID-13  

is invalid

  The value is in an improper format and cannot be parsed. May be caused by a length other than 7 or 10 characters or an issue with parentheses.

Patient Primary Facility ID

PD1-3.3  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the Facility ID code value table.

Patient Primary Facility Name

PD1-3.1  

Patient Primary Physician ID

PD1-4.1  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the Physician ID code value table.

Patient Publicity Code

PD1-11  

is unrecognized

  The code is not recognized.

Patient Race

PID-10  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the Race code value table.

Patient Immunization Registry Status

PD1-16  

Patient VFC Status

PV1-20.1  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the VFC code value table.

Patient Consent

PD1-12  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not recognized.

Vaccination Tab

Issue Resolution Name

HL7 Field

Description

Vaccination Patient Vaccinations Quantity

RXA  

is missing

  No vaccinations are in the message.

exceeds 10

  A message contains more than 10 vaccinations given on a single day. More than 10 vaccinations can be sent at the same time as long as 10 or fewer of them were given on the same date.

Vaccination

RXA  

is historical; with same encounter submission date

  A vaccination is historical, but the administered date is the same as the submission date.

is not recorded as a single vaccination event

  When the vaccination lot numbers, manufacturers, and dates of any two or more vaccinations match, it is assumed they should be part of a combo vaccination.

Vaccination Date

RXA-3  

is invalid

  The incoming value is a date that cannot be parsed because it is not in a format that is understood. Currently accepts format: YYYYMMDD. When a date less than 8 digits is passed in the RX-3 field and the issue resolution is set to:
  • Error - The message is rejected
  • Warn or Ignore - The Vaccination Date is Invalid warning is raised, the date is changed to a valid date, and the new date is passed to the registry

is after the lot expiration date

  The lot number expiration date is before the vaccination date.

was more than 30 days ago

  The vaccination date is more than 30 days from the submission date.

is an ACIP schedule violation

  A violation of the licensing criteria has occurred.

is after the patient's death date

  The patient's death date is before the vaccination date.

Vaccination ID

ORC-3 No validations raised for historical vaccinations.

is not unique

  Not a unique ID to any newly administered vaccinations.

Vaccination Action Code

RXA-21  

Vaccination Administered Units

RXA-7  

Vaccination NDC Number

RXA-5.1, RXA-5.4  

is invalid

  The code is recognized, but it is marked as invalid in the code value table.

is unrecognized

  The code is not listed in the NDC Vaccine Code code value table.

Vaccination CPT Code

RXA-5.1, RXA-5.4  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the CPT Vaccine Code code value table.

Vaccination CVX Code

RXA-5.1, RXA 5.4  

is invalid

  The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

  The code is not listed in the CVX Vaccine Code code value table.

is CVX and CPT codes are inconsistent

  The codes are not from the same vaccine group established by the CDC.
Vaccination Completion Status RXA-20  

is unrecognized

  The value is not recognized.

is inconsistent with refusal reason

  When the RXA-18 (Refusal Reason) field is populated, the value of the RXA-20 (Vaccination Completion Status) field should be RE. If any other value is populated in the RXA-20 field, the value is marked as inconsistent.

Vaccination Facility ID

RXA-11.1, RXA-11.4, MSH-4.1, MSH-4.2  

is invalid (inactivated in the IIS); on an administered vaccination

 

The ID is recognized on an administered vaccination, but is inactive.

is invalid (inactivated in the IIS); on a historical vaccination

 

The ID is recognized on a historical vaccination, but is inactive.

is unrecognized; on an administered vaccination

 

The value sent is an unusual code value, but can be mapped in the code value table.

is unrecognized; on a historical vaccination

 

The value sent is an unusual code value, but can be mapped in the code value table.

exceeds maximum length

 

Exceeds 25 characters.

Vaccination Information Source

RXA-9

 

Vaccination VIS Publication Date

OBX 29768-9, 69764-9

 

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is in the future

 

The publication date is a future date from the sent date.

is after the vaccination date

 

The publication date is after the vaccination date.

Vaccination VIS Barcode

OBX 69764-9

 

is invalid

 

Not available at this time.

is unrecognized

 

The barcode is not in the list PHC Hub has on file. The file is updated periodically from the posted CDC values.

Vaccination VIS Given Date

OBX 29769-7

 

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is in the future

 

The VIS given date is a future date from the sent date.

Vaccination Lot

RXA-15

No validations raised for historical vaccinations.

is invalid

 

One or more instances of the lot number exist in the IIS, but none of them are active.

is unrecognized

 

There are no active or inactive lot numbers in the IIS that match.

does not match manufacturer code

 

If there is at least one lot number in the IIS with a matching lot number and the vaccine code indicated is in the same group as the vaccine code on one or more lot numbers in the IIS, the manufacturer code is checked for consistency among the lot numbers.

does not match funding source

 

If there is at least one lot number in the IIS with a matching lot number and the vaccine code indicated is in the same group as the vaccine code on one or more lot numbers in the IIS, the funding source code is checked for consistency among the lot numbers.

does not match expiration date

 

If there is at least one lot number in the IIS with a matching lot number and the vaccine code indicated is in the same group as the vaccine code on one or more lot numbers in the IIS, the expiration date is checked for consistency among the lot numbers.

does not match vaccine group

 

The value doesn't match the vaccine group.

Vaccination Lot Expiration Date

RXA-16

 

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

Vaccination Manufacturer

RXA-17

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is listed in the code value table.

Vaccination VFC Status

OBX

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is not listed in the VFC code value table.

Vaccination Funding Source

OBX

 

is invalid

 

The mapping has been deactivated in the registry.

is unrecognized

 

The funding source is not created in the Define Lookups > Define Funding Source in the registry.

VFC Eligibility and Funding Source are inconsistent

 

There's an inconsistency between the provided eligibility and funding source.

Vaccination Entering Organization

ORC-17.1

 

Vaccination Ordering Provider

ORC-12

 

is invalid

 

The physician/vaccinator is in the list, but is inactive.

is unrecognized

 

The value is not in the physician/vaccinator list.

Vaccination ID of Vaccinator

RXA-10

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

Vaccination Route

RXR-1

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

Vaccination Anatomical Site

RXR-2

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

Deferral Tab

Issue Resolution Name

HL7 Field

Description

Deferral Substance Refusal Reason

RXA-18

 

is unrecognized

 

The code is not recognized.

Deferral Substance Refusal Date

RXA-3

 

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is after the lot expiration date

 

The lot number expiration date is before the deferral date.

was more than 30 days ago

 

The date is more than 30 days ago.

is after the patient's death date

 

The patient's date of birth is after the deferral date.

Next of Kin Tab

Issue Resolution Name

HL7 Field

Description

Next of Kin First Name

NK1-2.2

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Next of Kin Middle Name

NK1-2.3

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Next of Kin Last Name

NK1-2.1

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Next of Kin Phone

NK1-5

 

is invalid

 

Considered invalid if it is an improper format and cannot be parsed. May be caused by a length other than 7 or 10 characters or an issue with parentheses.

Next of Kin Address County

NK1-4.9

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is not listed in the code value table.

Next of Kin Relationship

NK1-3

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is not listed in the code value table.

Next of Kin SSN

NK1-33

 

is invalid

 

Considered invalid if:

  • Contains characters other than 0-9
  • Is one of the following values: 987-65-4320, 987-65-4321, 123-45-6789

Guardian Tab

Missing guardian information is ignored if the patient is 19 years of age or older.

Issue Resolution Name

HL7 Field

Description

Guardian First Name

NK1-2.2

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Guardian Middle Name

NK1-2.3

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space.
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Guardian Last Name

NK1-2.1

Names can contain 48 characters. Alphabetic characters, hyphens, apostrophes, and spaces are all valid.

is invalid

 

Considered invalid if:

  • Contains characters other than A-Z, a-z, single quote, dash, period, or space
  • Is one of the values defined in the Bogus Names field (Application Settings > Bogus Names)

Guardian Phone Number

NK1-5

 

is invalid

 

Considered invalid if it is an improper format and cannot be parsed. May be caused by a length other than 7 or 10 characters or an issue with parentheses.

Guardian Address Street

NK1-4.1

 

is invalid

 

Considered invalid if one of these values: Anywhere, Nowhere, Address, Address 1, Address 2

Guardian Address Street2

NK1-4.2

 

Guardian Address City

NK1-4.3

 

is invalid

 

Not currently available.

Guardian Address State

NK1-4.4

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

Guardian SSN

NK1-33

 

is invalid

 

Considered invalid if:

  • Contains characters other than 0-9
  • Is one of the following values: 987-65-4320, 987-65-4321, 123-45-6789

Message Header Tab

Issue Resolution Name

HL7 Field

Description

Message Header Sending Facility

MSH-4.1, MSH-4.2

 

is missing

 

This validation is not triggered if the Import Facility ID (RXA-11) From MSH-4.1/4.2 option is enabled and a value is provided for the Vaccination Facility ID by one of those fields.

Contraindication Tab

Issue Resolution Name

HL7 Field

Description

Contraindication Concept Code

OBX

OBX 30945-0, 59784-9

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is not listed in the code value table.

Contraindication Observation Date

OBX-14

 

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is in the future

 

The observation date is a future date from the sent date.

is before the patient's date of birth

 

The patient's date of birth is after the observation date.

Contraindication Effective Date

OBX

OBX 30946-8

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is before the patient's date of birth

 

The patient's date of birth is after the effective date.

Contraindication Expiration Date

OBX

OBX 30944-3

is invalid

 

The incoming value is a date that cannot be parsed because it is not in a format that is understood. Checks length of date sent.

is before the patient's date of birth

 

The patient's date of birth is after the expiration date.

Insurance Tab

Issue Resolution Name

HL7 Field

Description

Insurance Company

IN1-3

 

is invalid

 

The code is recognized, but is either inactive or marked invalid in the code value table.

is unrecognized

 

The code is not listed in the code value table.

Difference vs. Template

Displays the differences between this profile and its parent template.

Additional Validation Tabs

Additional validations occur after PHC Hub has accepted a message, but before IWeb submission.

Description Error Message
Verify the IRMS SYS ID is a non-negative number Invalid IRMS system ID.
Verify the Vaccine date is present and not in the future Invalid or missing vaccination date.
Verify that either a patient ID or a billing patient ID is submitted Missing patient ID.
Verify that a patient ID is not submitted along with a billing patient ID IRMS patient ID and Billing patient ID both present.
Verify at least one SIIS, CDC, CPT, or ICD-9 code has been submitted ASIIS vaccine code not found.
Verify that if both of the CDC and SIIS codes are missing and/or invalid, the CPT code is present and valid ASIIS vaccine code not found.
Verify that if all three of the CDC, SIIS, and CPT codes are missing and/or invalid, the ICD-9 code is present and valid ICD-9 code not found.
Verify that if just the SIIS code is missing or invalid, the CDC code is present and valid CDC vaccine code not found.
Verify that if the SIIS code is present, that it is valid ASIIS vaccine not found.
Verify that the specific vaccination isn't being blocked from entry Administered vaccination cannot be unspecified antigen.
Verify the patient hasn't been blocked IRMS sys-pat ID blocked; Patient deleted from registry.
STC | One logo