addPatients

Add patients to a project. Data requestors can add patients using direct patient data (patients array). Healthcare organizations can add patients using MRNs (mrns array) with notification type selection.

Path Parameters
projectId string — REQUIRED Project Id

Request Body — REQUIRED Patient data to add. Use 'patients' array for direct patient data or 'mrns' array for MRN-based addition (healthcare organizations only)
patients object[] Array of patients to add to the project lastName string — REQUIRED Last name of the patient firstName string — REQUIRED First name of the patient externalId string External ID of the patient dateOfBirth date-time Date of birth of the patient email string Email of the patient phone string Phone number of the patient mrn string MRN of the patient contactPreference string — REQUIRED Possible values: [email, phone] Contact preference of the patient languagePreference string — REQUIRED Possible values: [en, es] Language preference of the patient targetedFacilities array[] List of National Provider Identifier (NPI) numbers for the patient's care facilities allowOnlyTargetedFacilities boolean When enabled, allows only facilities that are in the targetedFacilities list
mrns object[] Array of MRNs to add to the project mrn string — REQUIRED MRN of the patient for healthcare organizations patientNotificationType string Possible values: [ENROLLMENT_REQUEST] Patient notification type for the patient. If not provided, defaults to enrollment requested.

Responses

200 Results of adding patients including success count, errors, and duplicates. For MRN-based additions, patient details are fetched automatically from the healthcare organization's system. Schema — OPTIONAL totalProcessed number Total number of patients processed in the request successCount number Number of patients successfully added errorCount number Number of patients that failed to be added due to validation errors duplicatesCount number Number of patients that were duplicates and not added errors object[] — OPTIONAL Array of errors that occurred during patient processing patientIndex number Index of the patient in the original request array that caused the error error string Description of the error that occurred while processing this patient duplicates object[] — OPTIONAL Array of duplicate patients that were not added patientIndex number Index of the patient in the original request array that was a duplicate existingPatientId string ID of the existing patient that was already in the system duplicateFields string[] List of fields that matched the existing patient