| Test | Description |
|---|---|
| Alanine aminotransferase (ALT) | Tests for elevated levels of ALT in blood which would indicate liver damage. The results are given in IU/L (international units per liter). |
| Anti-HAV IgM | Detects IgM antibodies to the Hepatitis A virus |
| Anti-HBc IgM | Detects IgM antibodies against Hepatitis B core antigen, a component of the Hep B virus |
| HBsAg | Detects the presence of the Hepatitis B surface antigen |
| Anti-HCV | Detects any antibodies against the Hepatitis C virus |
| HCV RNA | Detects the RNA of the Hepatitis C virus (to confirm an active infection) |
| HDV testing | Detects antibodies to the hepatitis D virus |
| Anti-HEV IgM | Detects IgM antibodies against the Hepatitis C virus |
AVH: Acute Viral Hepatitis Case Reporting (in DHIS2)
DHIS2 Event Program Documentation
This DHIS2 event program aims to support case reporting and surveillance of acute viral hepatitis.
It is designed to cover the full life cycle of a case from initial notification through to final classification, supporting data entry at each stage: clinical assessment, specimen collection, exposure and risk-factor investigation, hospitalization and outcome, and disease-specific final classification.
It is intended to be compliant with all available WHO surveillance standards for viral hepatitis and to facilitate reporting compliant with the reporting requirements for each hepatitis type.
1 Background
Five known hepatitis viruses - A, B, C, D, and E (HAV, HBV, HCV, HDV and HEV) are collectively responsible for an estimated 1.46 million deaths per year globally (World Health Organization 2016). The acute illnesses caused by these viruses are clinically indistinguishable at the point of first contact.
1.1 Source documents
This document and the AVH Event program itself are based on several source documents. (See references section for more detailed information.)
(World Health Organization 2016) is the main guiding document for surveillance of viral hepatitis. (World Health Organization 2018a) and (World Health Organization 2018b) are surveillance standards for Hepatitis A and Hepatitis B respectively (and can be considered to be summaries of relevant information from (World Health Organization 2016)).
The data capture form provided by the event program is largely intended to replicate the template reporting form provided in (World Health Organization 2019).
Some language used in this document and in the event program is taken verbatim from these source documents.
1.2 The hepatitis viruses
Hepatitis A (HAV) is transmitted through the fecal-oral route, including through personal contact, water, and food. A serological assay (IgM anti-HAV) is available to diagnose recent infection. There is a vaccine available. WHO standards allow for case confirmation via laboratory confirmation or an epidemiological link to a laboratory confirmed case.
Hepatitis B (HBV) is transmitted through exposure to blood and body fluids, including perinatal, percutaneous and sexual. Hepatitis B infections among children often lead to chronic disease. Acute Hepatitis B among adults is usually self-limiting. A serological assay (IgM anti-HBc) is available to diagnose recent infection. There is a vaccine available and recommended for all newborns. WHO standards allow only for case classification via laboratory confirmation.
Hepatitis C (HCV) is mostly transmitted via exposure to infected blood. Chronic infections can lead to hepatocellular carcinoma (HCC) and cirrhosis. New HCV infections uncommonly cause acute hepatitis. Serological assays for HCV (total anti-HCV) does not distinguish between new, chronic, and resolved. Distinguishing resolved infection from chronic infection requires either HCV core antigen testing or nucleic acid testing (NAT) to detect HCV RNA. No vaccine is available yet. WHO standards allow only for case classification via laboratory confirmation.
Hepatitis D (HDV) is a bloodborne, incomplete virus that needs HBV to replicate. Infection can be prevented through Hepatitis B vaccination. (This event program offers no components specific to Hepatitis D currently.)
Hepatitis E (HEV) is transmitted through the fecal-oral route, mostly through fecally contaminated water. Hepatitis E often occurs as large waterborne outbreaks. Person-to-person transmission is uncommon. A serological test (IgM anti-HEV) is available to diagnose recent infection. The WHO has not recommended a vaccine for widespread use. WHO standards allow for case confirmation via laboratory confirmation or an epidemiological link to a laboratory confirmed case.
1.3 Laboratory testing for hepatitis viruses
The table below lists some of the available laboratory tests for detecting hepatitis viruses.
1.4 Laboratory confirmation criteria
WHO guidance specifies certain allowable biomarker profiles appropriate for laboratory-confirmed case classifications for each hepatitis virus.
| Virus | Lab-confirmation criteria for Acute Hepatitis |
|---|---|
| HAV | Someone who meets the presumptive case definition and is positive for IgM anti-HAV |
| HBV | ELISA testing for immunoglobulin M antibodies to core antigen of hepatitis B (anti-HBC IgM) |
| HCV | 1. HCV-RNA positive and anti-HCV negative or 2. HCV-RNA positive in persons previously negative or 3. Occurrence with clinical acute hepatitis with a test positive for anti-HCV after exclusion of hepatitis A, B, and E. |
| HDV | Someone who meets the presumptive case definition and is positive for IgM anti-HEV |
2 Installing the Event Program
Successful installation of the AVH event program should involve the following steps:
- Importing the event program metadata (
AVH_metadata_dependencies_complete_program.json) via theImport/Exportapp - Making the event program available for data entry at specified organisation units (using the
MaintenanceorMetadata Managementapps) - Creating users if necessary
- Adding admin users to the
AVH Level 1user group - Adding data entry users to the
AVH Level 2user group - Assigning the
AVH Capture User(or a comparable role) to data entry users if necessary
3 AVH Technical details
3.1 Data Elements
The program contains 103 data elements organised into 12 sections. The table below lists all fields in section order with relevant details.
Value types are: DATE, TEXT (free text or option set), BOOLEAN (Yes/No checkbox), INTEGER_ZERO_OR_POSITIVE (non-negative whole number), COORDINATE (latitude/longitude), MULTI_TEXT (multi-select option set).
| Form name | code | id | valueType | Option Set |
|---|---|---|---|---|
| Patient Information | ||||
| Unique Identifier | AVH_RECORDID | W2pkAFEn3z5 | TEXT | |
| First Name | AVH_FIRSTNAME | BS9UYJQTFjm | TEXT | |
| Last Name | AVH_LASTNAME | dLEG62Hkd9G | TEXT | |
| Date of Birth | AVH_DOB | KpLMcNfAQLK | DATE | |
| Age in Years | AVH_AGEYEARS | iQPtDu7W7ea | INTEGER_ZERO_OR_POSITIVE | |
| Age in Months | AVH_AGEMONTHS | w4e4pxskC1I | INTEGER | AVH - Age in Months |
| Sex | AVH_SEX | Qg84iqh4gVJ | TEXT | AVH - Sex |
| Phone Number | AVH_PHONE | qGFq562dfOB | TEXT | |
| Address 1 | AVH_ADDRESS1 | JTBJahe84S5 | TEXT | |
| Address 2 | AVH_ADDRESS2 | tx57Y3c5wnR | TEXT | |
| Address 3 | AVH_ADDRESS3 | j77p3kZZl4A | TEXT | |
| Address 4 | AVH_ADDRESS4 | VZprkYSgy3c | TEXT | |
| Location | AVH_LOCATION | oobQmzvr3e9 | COORDINATE | |
| Date of Visit | AVH_DATEOFVISIT | bh4qlL9qcgM | DATE | |
| Clinical Presentation | ||||
| Date of Onset | AVH_DATEONSET | RU8VVQmxBe8 | DATE | |
| Fever | AVH_SXFEVER | GtQAuzSsJim | BOOLEAN | |
| Malaise | AVH_SXMALAISE | zJ1atsnBYLM | BOOLEAN | |
| Fatigue | AVH_SXFATIGUE | YVkQfsGQONv | BOOLEAN | |
| Anorexia | AVH_SXANOREXIA | bcpEN2XeDA4 | BOOLEAN | |
| Nausea | AVH_SXNAUSEA | Sa5W3X4gXBo | BOOLEAN | |
| Jaundice | AVH_SXJAUNDICE | hDiZDQHJMu8 | BOOLEAN | |
| Dark Urine | AVH_SXDARKURINE | JC5kV3ECqWp | BOOLEAN | |
| Right Upper Quadrant Tenderness | AVH_SXRUQPAIN | Tsprvu5Ifij | BOOLEAN | |
| Encephalopathy | AVH_ENCEPHALOPATHY | DAdn1Ay5XL8 | TEXT | AVH - Encephalopathy Grade |
| Acute Liver Failure? | AVH_ACUTELIVERFAIL | tWy2591AIVV | TEXT | AVH - Yes / No / Unknown |
| Hospitalization and Outcome | ||||
| Hospitalized? | AVH_HOSPITALIZED | wAvuQg2kvAS | TEXT | AVH - Yes / No / Unknown |
| Date of Hospitalization | AVH_HOSPDATE | uquhXz3G0aQ | DATE | |
| Discharge Date | AVH_DISCHARGEDATE | CWdnrJi7sC4 | DATE | |
| Outcome | AVH_OUTCOME | JaJAfo16hD8 | TEXT | AVH - Outcome |
| Date of Death | AVH_DATEDEATH | A1EEpDJjym6 | DATE | |
| Laboratory and Biomarkers | ||||
| Specimen Collected? | AVH_SPECIMEN | iNIb6zLKQbf | TEXT | AVH - Yes / No / Unknown |
| Specimen Type | AVH_SPECTYPE | DuvW4yrW81A | TEXT | AVH - Specimen Type |
| Date of Specimen Collection | AVH_DATESPEC | PeX9PcWb8pm | DATE | |
| Date Specimen Sent to Laboratory | AVH_DATESPECSENT | DSqXxkMM9VT | DATE | |
| Date Specimen Received at Laboratory | AVH_DATESPECRECV | KR69yz8TmeL | DATE | |
| ALT Result (IU/L) | AVH_ALTRESULT | ZhYKYcwIBQx | NUMBER | |
| Anti-HAV IgM | AVH_ANTIHAV_IGM 13950-1 | xO51DTjBlUH | TEXT | AVH - Lab Result |
| IgM Anti-HBc | AVH_ANTIHBC_IGM 24113-3 | ULru2p17fr4 | TEXT | AVH - Lab Result |
| Total Anti-HBc Result | AVH_ANTIHBC_TOTAL | ulFnwZqvr4M | TEXT | AVH - Lab Result |
| HBsAg | AVH_HBSAG 5196-1 | AFJWpSEPTFC | TEXT | AVH - Lab Result |
| Anti-HCV | AVH_ANTIHCV 13955-0 | xEJHwBVJvwS | TEXT | AVH - Lab Result |
| Previous Negative Anti-HCV test | AVH_PREV_NEG_ANTIHCV | D4GmBrVfpZr | BOOLEAN | |
| Date of negative Anti-HCV test | AVH_DATE_ANTIHCV_NEG | Y616snuFKXW | DATE | |
| HCV RNA presence | AVH_HCVRNA 11259-9 | I8WSlmnVErU | TEXT | AVH - Lab Result |
| HCV RNA viral load | AVH_HCVRNA 11011-4 | pioHuaL05Jo | NUMBER | |
| HDV Testing | AVH_HDVRESULT 40727-0 | ltaTIircdJs | TEXT | AVH - Lab Result |
| Anti-HEV IgM | AVH_ANTIHEV_IGM 14212-5 | sEECvl9dq83 | TEXT | AVH - Lab Result |
| HBV Genotype (if performed) | AVH_HBVGENOTYPE 104995-6 | jjZK8tfphJW | TEXT | |
| Date of Result | AVH_DATERESULT | Ct3LBtKNdN9 | DATE | |
| Other Laboratory Findings / Notes | AVH_OTHERHEP | plJekaACSME | TEXT | |
| Case Linkage and Source of Infection | ||||
| Contact with a Laboratory-Confirmed Case of Viral Hepatitis? | AVH_CONTACTCASE | CR74KPONu3O | TEXT | AVH - Yes / No / Unknown |
| Associated Case ID | AVH_ASSOCCASEID | dwGetDCcdx1 | TEXT | |
| Source of Infection | AVH_SOURCE | LJ9YV5cC6ZK | TEXT | AVH - Source of Infection |
| Case Classification | ||||
| Final Case Classification | AVH_FINALCLASS | TCCHHNkxx6s | TEXT | AVH - Final Case Classification |
| Hepatitis A - Final Case Classification | AVH_HEPA_FINALCLASS | evgJRysqU2Q | TEXT | AVH Hepatitis A/E - Case Classification |
| Hepatitis B - Final Case Classification | AVH_HEPB_FINALCLASS | R6HfPQBGxbx | TEXT | AVH Hepatitis B/C - Case Classification |
| Hepatitis C - Final Case Classification | AVH_HEPC_FINALCLASS | kl1SXNZ5kUC | TEXT | AVH Hepatitis B/C - Case Classification |
| Hepatitis E - Final Case Classification | AVH_HEPE_FINALCLASS | GHA9k0mZMi3 | TEXT | AVH Hepatitis A/E - Case Classification |
| Prior Diagnosis and Chronic Conditions | ||||
| Previously Identified with Chronic HBV Infection? | AVH_PRIORHBV | BhIoPj6r0je | TEXT | AVH - Yes / No / Unknown |
| Previously Identified with Chronic HCV Infection? | AVH_PRIORHCV | hDStSz8rGIF | TEXT | AVH - Yes / No / Unknown |
| Previous History of Other Chronic Liver Disease? | AVH_PRIORCLD | fo9R13KL8bW | TEXT | AVH - Yes / No / Unknown |
| Vaccination History | ||||
| Vaccinated against Hepatitis A? | AVH_VACC_HEPA_GIVEN | LLQF3jCIEwv | TEXT | AVH - Yes / No / Unknown |
| Number of Hepatitis A Vaccine Doses Received | AVH_VACC_HEPA_DOSES | Kyo2XAcuVET | INTEGER_ZERO_OR_POSITIVE | |
| Hepatitis A Vaccine - Date of Dose 1 | AVH_VACC_HEPA_DATE1 | iG9Lv3g32Cg | DATE | |
| Hepatitis A Vaccine - Date of Dose 2 | AVH_VACC_HEPA_DATE2 | EYqvNSzPf2v | DATE | |
| Vaccinated against Hepatitis B? | AVH_VACC_HEPB_GIVEN | IcNepOR6soV | TEXT | AVH - Yes / No / Unknown |
| Number of Hepatitis B Vaccine Doses Received | AVH_VACC_HEPB_DOSES | t5bcuYdswxB | INTEGER_ZERO_OR_POSITIVE | |
| Hepatitis B Vaccine - Received Birth Dose? | AVH_VACC_HEPB_BIRTHDOSE | N3yNRpF6Ljo | TEXT | AVH - Yes / No / Unknown |
| Hepatitis B Vaccine - Date of Dose 1 | AVH_VACC_HEPB_DATE1 | sRIkeC8wLtO | DATE | |
| Hepatitis B Vaccine - Date of Dose 2 | AVH_VACC_HEPB_DATE2 | pyKwKsSsb1Q | DATE | |
| Hepatitis B Vaccine - Date of Dose 3 | AVH_VACC_HEPB_DATE3 | VF155sXZoMZ | DATE | |
| Vaccinated with Combined Hepatitis A and B Vaccine? | AVH_VACC_HEPAB_GIVEN | R1iOg5OPctY | TEXT | AVH - Yes / No / Unknown |
| Number of Combined Hepatitis A and B Vaccine Doses Received | AVH_VACC_HEPAB_DOSES | AlmiYI4xHG6 | INTEGER_ZERO_OR_POSITIVE | |
| Vaccinated against Hepatitis E? | AVH_VACC_HEPE_GIVEN | V3vZhD9ejW9 | TEXT | AVH - Yes / No / Unknown |
| Number of Hepatitis E Vaccine Doses Received | AVH_VACC_HEPE_DOSES | fYzaqIhDxRV | INTEGER_ZERO_OR_POSITIVE | |
| Patient Risk Characteristics | ||||
| Health-care Worker Exposed to Blood through Patient Care? | AVH_RISK_HCW | eO0D6StPAhi | TEXT | AVH - Yes / No / Unknown |
| Man Who Has Sex with Other Men? | AVH_RISK_MSM | yDxQ8VS8IAL | TEXT | AVH - Yes / No / Unknown |
| Undergoes Haemodialysis? | AVH_RISK_HAEMODIALYSIS | rcSxnCC8p2x | TEXT | AVH - Yes / No / Unknown |
| Injecting Drug Use? | AVH_RISK_IDU | h820DfQnPOM | TEXT | AVH - Yes / No / Unknown |
| Exposure History — 2 to 6 Weeks Before Onset | ||||
| Involved in a Reported, Identified Outbreak? | AVH_EXP_OUTBREAK | Y5Mar2jiIqZ | TEXT | AVH - Yes / No / Unknown |
| Contact with Patient(s) with the Same Symptoms? | AVH_EXP_CONTACTSYMPTOMS | LublqdiVAHh | TEXT | AVH - Yes / No / Unknown |
| Ate Raw, Uncooked Shellfish (e.g. Oysters)? | AVH_EXP_SHELLFISH | o8NcUY63QHt | TEXT | AVH - Yes / No / Unknown |
| Ate Raw, Uncooked Pork, Boar Meat or Venison? | AVH_EXP_PORK | FT6Ce5fuMje | TEXT | AVH - Yes / No / Unknown |
| Drank Water from a Well or Other Unsafe Source? | AVH_EXP_WATER | sDGMBgYSh2P | TEXT | AVH - Yes / No / Unknown |
| Child or Staff Member in a Day-care Centre? | AVH_EXP_DAYCARE | Av0DzAUguBu | TEXT | AVH - Yes / No / Unknown |
| Travelled to an Area Highly Endemic for Hepatitis A / Hepatitis E? | AVH_EXP_TRAVEL | ffBgVVxZiJd | TEXT | AVH - Yes / No / Unknown |
| Exposure History — 1 to 6 Months Before Onset | ||||
| Received Injections Given for Therapeutic Purposes? | AVH_EXP_INJECTIONS | gKGnjQEo2gw | TEXT | AVH - Yes / No / Unknown |
| Admitted to Hospital? | AVH_EXP_HOSPITALADM | X0NNRPJbM7Q | TEXT | AVH - Yes / No / Unknown |
| Underwent a Surgical Procedure? | AVH_EXP_SURGERY | al3jKQzejVO | TEXT | AVH - Yes / No / Unknown |
| Received a Blood Transfusion? | AVH_EXP_TRANSFUSION | tUuX8KMf4dj | TEXT | AVH - Yes / No / Unknown |
| Received Dental Care? | AVH_EXP_DENTAL | MCArnWGhwBh | TEXT | AVH - Yes / No / Unknown |
| Underwent Endoscopy? | AVH_EXP_ENDOSCOPY | Mdant8nXiWq | TEXT | AVH - Yes / No / Unknown |
| Underwent Tattooing or Body Piercing? | AVH_EXP_TATTOO | ToGJ1QZwez3 | TEXT | AVH - Yes / No / Unknown |
| Underwent Shaving by a Barber? | AVH_EXP_BARBER | KzTOAshzb9u | TEXT | AVH - Yes / No / Unknown |
| Unprotected Sex with an Occasional Partner? | AVH_EXP_SEX | gpBLzHfz3tV | TEXT | AVH - Yes / No / Unknown |
| Household Contact with Someone with Hepatitis B / C? | AVH_EXP_HOUSEHOLD | m5XwwU90P0j | TEXT | AVH - Yes / No / Unknown |
| Reporting | ||||
| Date of Reporting | AVH_DATEREPORT | bu7g1TPvYji | DATE | |
| Reporting Facility | AVH_REPFACILITY | CNa5fbqn1jJ | TEXT | |
| Date of Notification to Public Health | AVH_DATENOTIF | pAOYNDeh15F | DATE | |
| Date of Investigation | AVH_DATEINVESTIG | aNwpKAlQQfH | DATE | |
3.1.1 Data Elements for laboratory test results
The data elements for include LOINC(Regenstrief Institute, n.d.) classification codes in their names/codes as well as in metadata attributes. The table below lists all the data elements included in the metadata JSON file along with the corresponding Common Long Name in the LOINC classification database.
(Note that two of data elements in the table are not included by default in the AVH data capture form. DHIS2 instance administrators can include these data elements - or create others - to more accurately reflect the laboratory tests used, if necessary.)
| Data Element | Form Name | LOINC Common Long Name | Note |
|---|---|---|---|
| AVH_ANTIHAV_IGM 13950-1 | Anti-HAV IgM | Hepatitis A virus IgM Ab [Presence] in Serum or Plasma by Immunoassay | |
| AVH_ANTIHBC_IGM 24113-3 | IgM Anti-HBc | Hepatitis B virus core IgM Ab [Presence] in Serum or Plasma by Immunoassay | |
| AVH_HBSAG 5196-1 | HBsAg | Hepatitis B virus surface Ag [Presence] in Serum or Plasma by Immunoassay | |
| AVH_ANTIHCV 13955-0 | Anti-HCV | Hepatitis C virus Ab [Presence] in Serum or Plasma by Immunoassay | |
| AVH_ANTIHCV 16128-1 | Anti-HCV | Hepatitis C virus Ab [Presence] in Serum | Not included in default data capture form |
| AVH_HCVRNA 11259-9 | HCV RNA presence | Hepatitis C virus RNA [Presence] in Serum or Plasma by NAA with probe detection | |
| AVH_HCVRNA 11011-4 | HCV RNA viral load | Hepatitis C virus RNA [Units/volume] (viral load) in Serum or Plasma by NAA with probe detection | |
| AVH_HDVRESULT 40727-0 | HDV Testing | Hepatitis D virus Ab [Presence] in Serum by Immunoassay | |
| AVH_ANTIHEV_IGM 14212-5 | Anti-HEV IgM | Hepatitis E virus IgM Ab [Presence] in Serum | |
| AVH_ANTIHEV_IGM 83128-9 | Anti-HEV IgM | Hepatitis E virus IgM Ab [Presence] in Serum or Plasma by Immunoassay | Not included in default data capture form |
| AVH_HBVGENOTYPE 104995-6 | HBV Genotype (if performed) | Hepatitis B virus genotype [Identifier] in Serum or Plasma by Sequencing |
3.2 Option Sets
The program uses 11 option sets which are described below.
DHIS2 admins may choose to edit the metadata to have pre-existing/other option sets at their discretion.
| Option set | id | options |
|---|---|---|
| AVH - Age in Months | GMbJmTPSIAo | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 |
| AVH - Encephalopathy Grade | CLrZ3aWZkSB | No encephalopathy, Grade I, Grade II, Grade III, Grade IV |
| AVH - Final Case Classification | w2wMqZcUDIh | Hepatitis A — Laboratory-confirmed, Hepatitis A — Epidemiologically linked, Hepatitis B — Laboratory-confirmed, Hepatitis C — Laboratory-confirmed, Hepatitis E — Laboratory-confirmed, Hepatitis E — Epidemiologically linked, Non-viral cause identified, Unknown / undetermined |
| AVH - Lab Result | vT4kOPP8lv8 | Positive, Negative, Indeterminate or Equivocal, Not done, Pending, Unknown |
| AVH - Outcome | ztnzxkdtA3H | Alive — Discharged, Alive — Transferred, Died (institutional), Died (community), Unknown |
| AVH - Sex | jroZR2T9JiK | Male, Female |
| AVH - Source of Infection | p4l2G02E7CA | Endemic — local transmission with no imported link, Imported — infection acquired in another country, Import-related — locally acquired from an imported case, Unknown — source not identified |
| AVH - Specimen Type | vrjn9Wvgfyg | Serum, Whole blood, Plasma, Other |
| AVH - Yes / No / Unknown | hR50RixhlE7 | Yes, No, Unknown |
| AVH Hepatitis A/E - Case Classification | LCvADiBniCG | Laboratory-confirmed, Epidemiologically linked, Discarded |
| AVH Hepatitis B/C - Case Classification | RbkKR94kMQI | Laboratory-confirmed, Discarded |
3.3 Users Groups and User Roles
3.3.1 User Groups
The event program metadata creates 2 User groups.
| User group | id | Description |
|---|---|---|
| AVH Level 1 | YRf53KKIFEi | Acute Viral Hepatitis surveillance — Admin users. |
| AVH Level 2 | ZPuPYP20gP1 | Acute Viral Hepatitis surveillance — Data entry personnel. |
| Objects | AVH Level 1 | AVH Level 2 |
|---|---|---|
| Data Elements | Metadata read+write | Metadata read only |
| Option sets | Metadata read+write | Metadata read only |
| Program | Metadata read+write, Data read+write | Metadata read only, Data read+write |
| Program stage | Metadata read+write, Data read+write | Metadata read only, Data read+write |
3.3.2 User Roles
The program metadata creates 1 User role.
AVH Capture User user role provides users access to the Browser Cache Cleaner, Capture, and Dashboard apps. If the event program is being installed to an instance of DHIS2 that already has a role of comparable functionality, administrators can choose to use the pre-existing user role for accounts being used to carry out data entry.
3.4 Program Rules
The event program metadata includes 43 Program Rules. These rules collectively serve to streamline data capture, enforce consistency between related data inputs, and to ensure that mandatory data fields are captured before an event is marked as Complete.
The table below gives descriptions of each of the Program Rules.
| Rule | Description |
|---|---|
| Always hide AVH_HEPA_FINALCLASS | Hides Hepatitis A final classification. This value is set by a program rule based on the overall final case classification. |
| Always hide AVH_HEPB_FINALCLASS | Hides Hepatitis B final classification. This value is set by a program rule based on the overall final case classification. |
| Always hide AVH_HEPC_FINALCLASS | Hides Hepatitis C final classification. This value is set by a program rule based on the overall final case classification. |
| Always hide AVH_HEPE_FINALCLASS | Hides Hepatitis E final classification. This value is set by a program rule based on the overall final case classification. |
| Assign Event Date to Date of Visit and Hide Field | Hides the Date of Visit field and sets its value to the event date. This avoids duplication in the data entry form while allowing the Date of Visit field to be used in downstream queries and visualizations. |
| Classification: Hepatitis A — Epidemiologically linked | If the final case classification is Hepatitis A - Epidemiologically linked then: 1) Set Hep A case classification to EpiLinked 2) Set Hep B, Hep C, and Hep E case classifications to Discarded |
| Classification: Hepatitis A — Laboratory-confirmed | If the final case classification is Hep A - Lab-confirmed then: 1) Set Hep A case classification to LabConfirmed 2) Set Hep B, Hep C, and Hep E case classifications to Discarded |
| Classification: Hepatitis B — Laboratory-confirmed | If the final case classification is Hepatitis B - Lab-confirmed then: 1) Set Hep B case classification to Lab confirmed 2) Set Hep A, Hep C, and Hep E case classifications to Discarded |
| Classification: Hepatitis C — Laboratory-confirmed | If the final case classification is Hepatitis C - Lab-confirmed then: 1) Set Hep C case classification to Lab confirmed 2) Set Hep A, Hep B, and Hep E case classifications to Discarded |
| Classification: Hepatitis E — Epidemiologically linked | If the final case classification is Hep E - Epidemiologically linked then: 1) Set Hep E case classification to EpiLinked 2) Set Hep A, Hep B, and Hep C case classifcations to Discarded |
| Classification: Hepatitis E — Laboratory-confirmed | If the final case classification is Hep E - Lab confirmed then: 1) Set Hep E case classification to Lab confirmed 2) Set Hep A, Hep B, and Hep C case classifications to Discarded |
| Classification: Non-viral — set ABCE to Discarded | If the final overall case classication is Nonviral then set Hep A, Hep B, Hep C, and Hep E classifications to Discarded |
| Completion: Anti-HAV IgM required for Hepatitis A lab-confirmed classification | Ensuring that the test result is recorded for a Hep A lab-confirmed classification. |
| Completion: Anti-HEV IgM required for Hepatitis E lab-confirmed classification | Ensuring that the test result is recorded for a Hep E lab-confirmed classification. |
| Completion: At least one age field required | Ensuring that at least one of the fields in the form that allows for determining patient's age is completed. |
| Completion: Date of Onset Required | Ensuring that a date of symptom onset is recorded. |
| Completion: Final Case Classification Required | Case cannot be marked as complete without a final case classification. |
| Completion: HCV RNA required for Hepatitis C lab-confirmed classification | Ensuring that the test result is recorded for a Hep C lab-confirmed classification. |
| Completion: IgM anti-HBc required for Hepatitis B lab-confirmed classification | Ensuring that the test result is recorded for a Hep B lab-confirmed classification. |
| Completion: Sex Required | Ensuring that the patient's sex is recorded. |
| Completion: Specimen Collected is required | Ensuring that specimen collection (Yes/No/Unknown) is documented. |
| Completion: Unique Identifier Required | Ensures that a Patient Identifier is recorded |
| Completion: Valid biomarker profile needed for Hepatitis C lab-confirmed | Ensures that one of the valid biomarker profile is recorded to accompany a hepatitis C lab-confirmed case classification. |
| Error: Anti-HAV IgM must be Positive for Hepatitis A lab-confirmed | Ensuring that the appropriate laboratory test is recorded to substantiate a Hepatitis A lab-confirmed case classification. |
| Error: Anti-HEV IgM must be Positive for Hepatitis E lab-confirmed | Ensuring that the appropriate laboratory test is recorded to substantiate a Hepatitis E lab-confirmed case classification. |
| Error: Contact with confirmed case required for epi-linked classification | Ensuring that contact with a confirmed case is recorded consistent with epi-linked case classification (Hep A or Hep E). |
| Error: IgM anti-HBc must be Positive for Hepatitis B lab-confirmed | Ensuring that the appropriate laboratory test is recorded to substantiate a Hepatitis B lab-confirmed case classification. |
| Error: Onset date after visit date | Ensuring that the date of symptom onset is not later than the date of the visit. |
| Error: Specimen required for lab-confirmed classification | Ensuring that a collected specimen is recorded consistent with a lab-confirmed case classification. |
| Hide Age in Months when DOB entered or Age Years > 0 | Hides the Age in Months field if DOB or Age in Years >= 1 are recorded. |
| Hide Associated Case ID when No Contact with Case | Hide field for associated case ID when there's no contact with a confirmed case. |
| Hide Combined Hepatitis A+B Vaccination Details when Not Vaccinated | Hide field for details when the patient was not vaccinated with Hep A+B vaccine. |
| Hide Date of Death when Outcome is not Death | Hide date of death field when the outcome is not death. |
| Hide HBV Genotype unless HBsAg Positive | Hide field for HBV Genotype unless HBsAg test result is Positive. |
| Hide HCV RNA unless Anti-HCV Positive | Hide HCV RNA details unless Anti-HCV is Positive |
| Hide Hepatitis A Vaccination Details when Not Vaccinated | Hide fields for details when the patient was not vaccinated with Hep A vaccine. |
| Hide Hepatitis B Vaccination Details when Not Vaccinated | Hide fields for details when the patient was not vaccinated with Hep B vaccine. |
| Hide Hepatitis E Vaccination Details when Not Vaccinated | Hide field for details when the patient was not vaccinated with Hep E vaccine. |
| Hide Hospitalization and Discharge Dates when Not Hospitalized | Hide fields for details of hospitalization when patient was not hospitalized. |
| Hide Laboratory Fields when No Specimen Collected | Hide fields for laboratory tests when no collected specimen is recorded. |
| Info: Enter DOB or age | Reminds user to enter patient's DOB or age. |
| Note: Final Case Classification Requirements | Show reminder of final case classification criteria. |
| Reminder: Record All Laboratory Tests Performed | Show reminder to enter all available test results. |