Rules
| Rule | Options | Description | Default |
|---|---|---|---|
accepted_types | See below | The types of certifications to accept | ['cpr', 'bls', 'acls', 'pals', 'first_aid'] |
accepted_issuers | See below | The 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_source | enforce , attempt , none | The primary source of the document | none |
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
| Issue | Description | Decision |
|---|---|---|
missing_id | The certification ID is missing | rejected |
missing_issuer | The certification issuer is missing | rejected |
missing_type | The certification type is missing | rejected |
invalid_certification | The certification is invalid | rejected |
unsupported_type | The certification type is not supported | rejected |
unsupported_issuer | The certification issuer is not supported | rejected |
too_many_certifications | The document contains too many certifications | flagged |
missing_expiration_date | The certification expiration date is missing | rejected |
invalid_issuer | The certification issuer is invalid | rejected |
primary_source_failed | Primary source verification failed | flagged |
