Skip to main content

Rules

RuleOptionsDescriptionDefault
accepted_typesSee belowThe types of certifications to accept['cpr', 'bls', 'acls', 'pals', 'first_aid']
accepted_issuersSee belowThe issuers of certifications to accept['american_heart_association', 'american_heart_association_rqi', 'american_red_cross', 'national_safety_council', 'american_safety_health_institute', 'protrainings', 'national_cpr_foundation']
primary_sourceenforce , attempt , noneThe primary source of the documentnone

Extracted data

Certification Issuers

"american_heart_association"
"american_heart_association_rqi"
"american_red_cross"
"national_safety_council"
"american_safety_health_institute"
"protrainings"
"national_cpr_foundation"
"other"

Certification Types

"cpr"
"bls"
"acls"
"pals"
"first_aid"
document_type: 'cdc' | 'digital' | 'electronic' | 'immunization_document' | 'declination';
person: {
    name: {
        source: string | null;
        extracted: string | null;
        status: 'match' | 'mismatch' | 'not_present';
    },
    dob: {
        source: string | null;
        extracted: string | null;
        status: 'match' | 'mismatch' | 'not_present';
    }
},
certifications: {
    id: string;
    type: 'cpr' | 'bls' | 'acls' | 'pals' | 'first_aid';
    date: string | null;
    issuer: 'american_heart_association' | 'american_red_cross' | 'american_heart_association_rqi' | 'other';
    issue_date: string | null;
    expiration_date: string | null;
    primary_source: {
        status: 'valid' | 'invalid' | 'expired',
        proof: string | null; // a url to the screenshot
    }
}[]
declination: {
    date: string | null;
    reason: 'medical' | 'personal' | 'religious' | null;
}

Issues

IssueDescriptionDecision
missing_idThe certification ID is missingrejected
missing_issuerThe certification issuer is missingrejected
missing_typeThe certification type is missingrejected
invalid_certificationThe certification is invalidrejected
unsupported_typeThe certification type is not supportedrejected
unsupported_issuerThe certification issuer is not supportedrejected
too_many_certificationsThe document contains too many certificationsflagged
missing_expiration_dateThe certification expiration date is missingrejected
invalid_issuerThe certification issuer is invalidrejected
primary_source_failedPrimary source verification failedflagged