match_score
Count a donor-recipient HLA match by the published counting rules (R1-R6): allele arithmetic over chromosomes, not a donor recommendation. recipient/donor: {"A": ["A01:01","A02:01"], "B": [...], ...} (two reported alleles per locus, any nomenclature era; allele strings only, no patient identifiers). framework: 6/6, 8/8, 10/10, 12/12, or antigen. Returns count, per-locus verdicts, GvH/HvG mismatch counts, and flags; unresolvable typing yields 'potential', never a confident count.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| donor | Yes | locus -> up to 4 reported allele names. Allele strings only: never patient names, medical record numbers, dates of birth, or accession or case identifiers. | |
| framework | No | 8/8 | |
| recipient | Yes | locus -> up to 4 reported allele names. Allele strings only: never patient names, medical record numbers, dates of birth, or accession or case identifiers. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 'matched/total' over the resolvable loci only, or UNRESOLVABLE when none resolves. Check verdicts for 'potential' loci before quoting it as a confident count. | |
| flags | Yes | e.g. resolution_insufficient, null_allele, null_allele_mismatch. | |
| release | Yes | IPD-IMGT/HLA release every verdict was computed against. | |
| verdicts | Yes | Framework locus -> verdict. | |
| framework | Yes | ||
| attribution | No | Data attribution (IPD-IMGT/HLA, CC-BY-ND). | |
| gvh_mismatches | Yes | Graft-versus-host mismatches over non-potential loci. | |
| hvg_mismatches | Yes | Host-versus-graft mismatches over non-potential loci. |