Configure DQA Report

The DQA report is defined by an XML document and encapsulates the IIS specific requirements for data quality for a given type of submitter. Initially DQA users have defined a global DQA report that is used for all providers, but as the DQA processes become more tuned additional DQA reports may be created that target specific types of submitters.

Working Example

Here is a working example used by MCIR:

<?xml version="1.0" encoding="utf-8"?>
<dqa-scoring>
  <section name="completeness" weight="50">
    <section name="patient" weight="45">
      <section name="required" weight="14">
        <score label="Patient Id" hl7Reference="PID-3" denominator="patient count" numerator="Patient submitter id" weight="10" />
        <score label="First Name" hl7Reference="PID-5.2" denominator="patient count" numerator="Patient name first" weight="5" />
        <score label="Last Name" hl7Reference="PID-5.1" denominator="patient count" numerator="Patient name last" weight="5" />
        <score label="Possible Test Name" hl7Reference="" denominator="patient count" numerator="Patient name may be test name" weight="-5" />
        <score label="Possible Baby Name" hl7Reference="" denominator="patient count" numerator="Patient name may be temporary newborn name" weight="-10" />
        <score label="Birth Date" hl7Reference="PID-7" denominator="patient count" numerator="Patient birth date" weight="10" />
        <score label="Sex" hl7Reference="PID-8" denominator="patient count" numerator="Patient gender" weight="5" />
        <score label="Address" hl7Reference="PID-11" denominator="patient count" numerator="Patient address" weight="2">
          <score label="Street" hl7Reference="PID-1" denominator="patient count" numerator="Patient address street" weight="5" />
          <score label="City" hl7Reference="PID-3" denominator="patient count" numerator="Patient address city" weight="1" />
          <score label="State" hl7Reference="PID-4" denominator="patient count" numerator="Patient address state" weight="1" />
          <score label="Zip" hl7Reference="PID-5" denominator="patient count" numerator="Patient address zip" weight="1" />
        </score>
      </section>
      <section name="expected" weight="4">
        <score label="Middle Name" hl7Reference="PID-5.3" denominator="patient count" numerator="Patient middle name" weight="10" />
        <score label="Phone" hl7Reference="PID-13" denominator="patient count" numerator="Patient phone" weight="10" />
        <score label="Mother's Maiden" hl7Reference="PID-6" denominator="patient count" numerator="Patient mother's maiden name" weight="10" />
      </section>
      <section name="recommended" weight="2">
        <score label="Ethnicity" hl7Reference="PID-22" denominator="patient count" numerator="Patient ethnicity" weight="10" />
        <score label="Race" hl7Reference="PID-10" denominator="patient count" numerator="Patient race" weight="10" />
        <score label="Responsible Party" hl7Reference="NK1" denominator="patient count" numerator="Patient guardian responsible party" weight="1">
          <score label="First Name" hl7Reference="NK1-2.2" denominator="patient count" numerator="Patient guardian name first" weight="4" />
          <score label="Last Name" hl7Reference="NK1-2.1" denominator="patient count" numerator="Patient guardian name last" weight="4" />
          <score label="Same as Patient" hl7Reference="NK1-3" denominator="patient count" numerator="Patient guardian name is same as underage patient" weight="-8" />
          <score label="Relationship" hl7Reference="NK1-3" denominator="patient count" numerator="Patient guardian relationship" weight="1" />
        </score>
      </section>
      <section name="optional" weight="0">
        <score label="Birth Indicator" hl7Reference="PID-24" denominator="patient count" numerator="Patient birth indicator" weight="0" />
        <score label="Medicaid Id" hl7Reference="PID-3" denominator="patient count" numerator="Patient Medicaid number" weight="0" />
        <score label="SSN" hl7Reference="PID-3" denominator="patient count" numerator="Patient SSN" weight="0" />
        <score label="Alias" hl7Reference="PID-5" denominator="patient count" numerator="Patient alias" weight="0" />
        <score label="Primary Language" hl7Reference="PID-15" denominator="patient count" numerator="Patient primary language" weight="0" />
        <score label="Resp Party Address" hl7Reference="NK1-4" denominator="patient count" numerator="Patient guardian address" weight="0">
          <score label="Street" hl7Reference="NK1-4.1" denominator="patient count" numerator="Patient guardian address street" weight="0" />
          <score label="City" hl7Reference="NK1-4.2" denominator="patient count" numerator="Patient guardian address city" weight="0" />
          <score label="State" hl7Reference="NK1-4.3" denominator="patient count" numerator="Patient guardian address state" weight="0" />
          <score label="Zip" hl7Reference="NK1-4.4" denominator="patient count" numerator="Patient guardian address zip" weight="0" />
        </score>
        <score label="Resp Party Phone" hl7Reference="NK1-5" denominator="patient count" numerator="Patient guardian phone" weight="0" />
        <score label="Address County" hl7Reference="PID-11.6" denominator="patient count" numerator="Patient address county" weight="0" />
        <score label="Financial Class" hl7Reference="PV1-20" denominator="patient count" numerator="Patient VFC status" weight="0" />
        <score label="Registry Status" hl7Reference="PD1-16" denominator="patient count" numerator="Patient registry status" weight="0" />
        <score label="Primary Physician" hl7Reference="PD1-4" denominator="patient count" numerator="Patient primary physician id" weight="0">
          <score label="Name" hl7Reference="" denominator="patient count" numerator="Patient primary physician name" weight="0" />
        </score>
        <score label="Primary Facility" hl7Reference="PD1-3" denominator="patient count" numerator="Patient primary facility id" weight="0">
          <score label="Name" hl7Reference="" denominator="patient count" numerator="Patient primary facility name" weight="0" />
        </score>
        <score label="Patient Registry Id" hl7Reference="PID-3" denominator="patient count" numerator="Patient registry id" weight="0" />
        <score label="Protection Indicator" hl7Reference="PD1-12" denominator="patient count" numerator="Patient protection indicator" weight="0" />
        <score label="Publicity Indicator" hl7Reference="PD1-11" denominator="patient count" numerator="Patient publicity code" weight="0" />
      </section>
    </section>
    <section name="vaccination" weight="45">
      <section name="required" weight="14">
        <score label="Vaccination Date" hl7Reference="RXA-3" denominator="vaccination count" numerator="Vaccination admin date" weight="40" />
        <score label="Vaccination Code" hl7Reference="RXA-5" denominator="vaccination count" numerator="Vaccination admin code" weight="40">
          <score label="Not Specific" hl7Reference="" denominator="vaccination admin count" numerator="Vaccination admin code is not specific" weight="-10" />
          <score label="Not Vaccine" hl7Reference="" denominator="vaccination count" numerator="Vaccination admin code is not vaccine" weight="-40" />
          <score label="Valued as Unknown" hl7Reference="" denominator="vaccination count" numerator="Vaccination admin code is valued as unknown" weight="-40" />
        </score>
        <score label="Information Source" hl7Reference="RXA-9" denominator="vaccination count" numerator="Vaccination information source" weight="40">
          <score label="May be Historical" hl7Reference="" denominator="vaccination count" numerator="Vaccination information source is administered but appears to historical"
            weight="-10" />
          <score label="May be Administered" hl7Reference="" denominator="vaccination count" numerator="Vaccination information source is historical but appears to be administered"
            weight="-10" />
        </score>
        <score label="VFC Status" hl7Reference="OBX-5" denominator="vaccination admin count" numerator="Vaccination financial eligibility code" weight="20" />
      </section>
      <section name="expected" weight="4">
        <score label="CVX Code" hl7Reference="RXA-5" denominator="vaccination count" numerator="Vaccination CVX code" weight="20" />
        <score label="Lot Number" hl7Reference="RXA-15" denominator="vaccination admin count" numerator="Vaccination lot number" weight="20" />
        <score label="Manufacturer" hl7Reference="RXA-17" denominator="vaccination admin count" numerator="Vaccination manufacturer code" weight="20" />
      </section>
      <section name="recommended" weight="2">
        <score label="Admin Amount" hl7Reference="RXA-6" denominator="vaccination admin count" numerator="Vaccination administered amount" weight="14">
          <score label="Missing Units" hl7Reference="RXA-7" denominator="vaccination admin count" numerator="Vaccination administered unit is missing" weight="-3" />
        </score>
        <score label="Completion Status" hl7Reference="RXA-20" denominator="vaccination admin count" numerator="Vaccination completion status" weight="6" />
      </section>
      <section name="optional" weight="0">
        <score label="Facility Id" hl7Reference="RXA-11" denominator="vaccination admin count" numerator="Vaccination facility id" weight="0" />
        <score label="Given By Id" hl7Reference="RXA-10" denominator="vaccination admin count" numerator="Vaccination given by" weight="0" />
        <score label="Action Code" hl7Reference="RXA-21" denominator="vaccination count" numerator="Vaccination action code" weight="0" />
        <score label="Ordered By" hl7Reference="ORC-12" denominator="vaccination admin count" numerator="Vaccination ordered by" weight="0" />
        <score label="Entered By" hl7Reference="ORC-10" denominator="vaccination count" numerator="Vaccination recorded by" weight="0" />
        <score label="Refusal Reason" hl7Reference="RXA-18" denominator="vaccination count" numerator="Vaccination refusal reason" weight="0" />
        <score label="Lot Expiration Date" hl7Reference="RXA-16" denominator="vaccination admin count" numerator="Vaccination lot expiration date" weight="0" />
        <score label="CPT Code" hl7Reference="RXA-5" denominator="vaccination count" numerator="Vaccination CPT code" weight="0" />
        <score label="System Entry Date" hl7Reference="RXA-22" denominator="vaccination count" numerator="Vaccination system entry time" weight="0">
          <score label="In Future" hl7Reference="" denominator="vaccination count" numerator="Vaccination system entry time is in future" weight="-5" />
        </score>
        <score label="Vaccination Id" hl7Reference="ORC-3" denominator="vaccination count" numerator="Vaccination id" weight="0" />
      </section>
    </section>
    <section name="vaccineGroup" weight="10">
      <section name="expected" weight="2">
        <section name="DTAP" weight="1" />
        <section name="HepB" weight="1" />
        <section name="POLIO" weight="1" />
        <section name="HIB" weight="1" />
        <section name="FLU" weight="1" />
        <section name="MMR" weight="1" />
        <section name="VARICELLA" weight="1" />
        <section name="PneumoPCV" weight="1" />
      </section>
      <section name="recommended" weight="1">
        <section name="HPV" weight="1" />
        <section name="ROTAVIRUS" weight="1" />
        <section name="Td" weight="1" />
        <section name="HepA" weight="1" />
      </section>
      <section name="optional" weight="0">
        <section name="RABIES" weight="0" />
      </section>
      <section name="unexpected" weight="-2">
        <section name="ANTHRAX" weight="1" />
      </section>
    </section>
  </section>
  <section name="quality" weight="40">
    <section name="errors" weight="28">
    </section>
    <section name="warnings" weight="12">
    </section>
  </section>
  <section name="timeliness" weight="10">
    <section name="early" weight="10" days="1">
    </section>
    <section name="onTime" weight="7" days="3">
    </section>
    <section name="late" weight="4" days="7">
    </section>
    <section name="veryLate" weight="1" days="30">
    </section>
    <section name="oldData" weight="0">
    </section>
  </section>
</dqa-scoring>

Document Structure

The DQA report is defined by a setting of nesting structures that define how the final score is put together and set out the report structure. This explanation assumes that you already understand how to read a standard DQA report.

XML Tag: dqa-scoring

This is the base tag for the document. This is required. It is expected to contain 3 section tags as elements where name is set to: completeness , quality , and timeliness .

XML Tag: section

The section tag may appear within the root dqa-scoring tag or within another section tag.

• name Required. Used by the DQA report generator to locate the settings for a section.
• weight Required. Indicates the weight for this section. Use an integer value. The actual weight assigned will be this value divided by the sum of all the weights defined at the same level, so the actual value is not as critical as to how it compares to all the other section values at the same level.
• days Optional. Indicates the number of days it took to report an administered vacciation for the timeliness sections. This value is expected in all timeliness sections and ignore in the others.

The DQA report has a pre-defined structure which this XML should mirror. The sections the DQA report expect are:

• completeness
  • patient
    • required
    • expected
    • recommended
    • optional
  • vaccination
    • required
    • expected
    • recommended
    • optional
  • vaccineGroup
    • expected
    • recommended
    • optional
    • unexpected
• quality
  • errors
  • warnings
• timeliness
  • early
  • onTime
  • late
  • veryLate
  • oldData

XML Tag: score

Within patient and vaccination completeness sections a score tag indicates how a specific field can be used to create the score for each section. This is where IIS specific requirements are documented and weighted.

• label Required. A short description that will be used on the report. This must be kept very short and concise in order to fit on the report. Longer descriptions will cause the display to wrap and make the tables harder to read.
• hl7Reference Optional. A short description of where in HL7 this field data should be placed.
• denominator Required. The object that should be used to count the total number of times this field should or should not appear. Valid values:
  • patient count The total number of patient records.
  • vaccination count The total number of vaccination records. (Adds, Deletes, non-administered, and historical included.)
  • vaccination admin count The total number of vaccination administered records. (Does not include deletes, historical and non-administered.)
• numerator This is a text key that links to the potential issue table. A valid value here is made from the concatenation of DQA_POTENTIAL_ISSUE.TARGET_OBJECT & SPACE & DQA_POTENTIAL_ISSUE.TARGET_FIELD. This link to the issue with the same target object and target_field where the issue_type = 'is missing'. This means that the DQA report determines how often a field has been received by subtracting the number of 'is missing' issues generated from the denominator. (For example, if a submitter always sends the patient name first, then there will be 0 issues register under 'patient name first is missing'. This is subtracted from the total number of patients and this shows the total number of times that 'patient name first is missing' was NOT the case. This is how the DQA report actually generates the completeness report. ) Here is a common set of numerators used:
  • Patient address
  • Patient address city
  • Patient address county
  • Patient address state
  • Patient address street
  • Patient address zip
  • Patient alias
  • Patient birth date
  • Patient birth indicator
  • Patient ethnicity
  • Patient gender
  • Patient guardian address
  • Patient guardian address city
  • Patient guardian address state
  • Patient guardian address street
  • Patient guardian address zip
  • Patient guardian name first
  • Patient guardian name is same as underage patient
  • Patient guardian name last
  • Patient guardian phone
  • Patient guardian relationship
  • Patient guardian responsible party
  • Patient Medicaid number
  • Patient middle name
  • Patient mother's maiden name
  • Patient name first
  • Patient name last
  • Patient name may be temporary newborn name
  • Patient name may be test name
  • Patient phone
  • Patient primary facility id
  • Patient primary facility name
  • Patient primary language
  • Patient primary physician id
  • Patient primary physician name
  • Patient protection indicator
  • Patient publicity code
  • Patient race
  • Patient registry id
  • Patient registry status
  • Patient SSN
  • Patient submitter id
  • Patient VFC status
  • Vaccination action code
  • Vaccination admin code
  • Vaccination admin code is not specific
  • Vaccination admin code is not vaccine
  • Vaccination admin code is valued as unknown
  • Vaccination admin date
  • Vaccination administered amount
  • Vaccination administered unit is missing
  • Vaccination completion status
  • Vaccination CPT code
  • Vaccination CVX code
  • Vaccination facility id
  • Vaccination financial eligibility code
  • Vaccination given by
  • Vaccination id
  • Vaccination information source
  • Vaccination information source is administered but appears to historical
  • Vaccination information source is historical but appears to be administered
  • Vaccination lot expiration date
  • Vaccination lot number
  • Vaccination manufacturer code
  • Vaccination ordered by
  • Vaccination recorded by
  • Vaccination refusal reason
  • Vaccination system entry time
  • Vaccination system entry time is in future
• weight Indicates the weight this issue should take. The weight is taken within consideration of the sum of all the positive weights given for all score objects placed under a section tag (including score tags next within another score tag.) If the weight is negative this is not included in the overall weight, but is weighted as a demerit. Which means it does not show on the report, or subtract from the score, unless the issue exists. In this way a positive score can be given for a field being valued and then some or all of the score subtracted if there are specific issues identified with this field.

A score tag under a section tag can have one more next score tag. These scores are shown on the report indented, implying they are part of a composite field. This is commonly used for address where the DQA can report on which parts of the address were actually sent. The weights in these sub sections count at the same level as all other weights within the same section, the nesting only implies indention within the report.