Several IDs for one patient
Send up to 5 IDs in one check and read which one matched.
identifiers takes up to 5 IDs for one patient. Each payer is searched with every usable ID; the
check returns one answer and names the ID that matched. This works on POST /v4/eligibility-checks
and POST /v4/appointment-checks.
{
"tpa_name": "INS026",
"visit_type": "OUTPATIENT",
"doctorName": "DHA-P-0000000",
"identifiers": [
{ "id_type": "CARDNUMBER", "id_value": "1234567890" },
{ "id_type": "EMIRATESID", "id_value": "784-1990-0000001-1" }
]
}| Rule | What happens |
|---|---|
| 1 to 5 entries | 6 or more, or an empty list, is 422 |
identifiers is the only form | Leaving it out is 422. id_type/id_value at the top level are not fields and are 422 ("Extra inputs are not permitted") |
| No duplicates | The same ID twice is 422; Emirates IDs match with or without dashes |
id_type values | EMIRATESID, CARDNUMBER, DHAMEMBERID, POLICYNUMBER; anything else is 422. A member number goes in as CARDNUMBER |
| Usable on the payer | An ID is used only if the payer accepts its type and, for Emirates IDs, the format is valid. At least one usable ID is enough; if none is usable you get 400 VALIDATION_FAILED with one entry per ID (field: identifiers[0].id_type, identifiers[1].id_value, ...) |
extra_args.identifiers | Reserved; sending it is 422 |
A list with one entry is an ordinary single-ID check. IDs are tried in the order you send them. The
first Emirates ID (or the first entry, if there is none) is the check's main ID: it is the one shown
as request.id_value.
In the result, each row in eligible_responses and other_responses adds matched_identifier
(the ID that found the member) and identifier_attempts (each ID tried and its outcome). Both show
only the last 4 characters of each ID, as does request.identifiers; the full list you sent is never
returned.
"matched_identifier": {"id_type": "CARDNUMBER", "id_value": "******7890"},
"identifier_attempts": [
{"id_type": "EMIRATESID", "id_value": "**************01-1", "outcome": "NOT_FOUND"},
{"id_type": "CARDNUMBER", "id_value": "******7890", "outcome": "FOUND", "is_eligible": true}
]GET /v4/eligibility-checks?q= finds the check by any card, member or policy number you sent, and
by its main Emirates ID. Cancelling a check cancels every Daman request it opened, one per ID that
reached Daman.