The Patient import object

Bulk imports of patient records. Patient API.

idstringRequired

Unique ID of the import.

statusrunning, completed, failedRequired

Progress of the import.

rowsintegerRequired

Rows received.

createdintegerRequired

Rows that created a new patient.

matchedintegerRequired

Rows that matched an existing patient.

failedintegerRequired

Rows that couldn’t be imported.

resultsarray of PatientImportRow or null

One result per row, once the import finishes. Null while it’s running.

Show child attributes

rowintegerRequired

Row number, starting at 1.

outcomecreated, matched, failedRequired

What happened to the row.

matched_bymrn, phone, email, null

Which field matched, for matched rows.

patient_idUUID or null

The created or matched patient.

errorstring or null

Why the row failed, like phone_or_email_required.

created_attimestampRequired

When the import started.

Method	Path	Endpoint
POST	`/patient-imports`	Import patients
GET	`/patient-imports/{importId}`	Retrieve an import