Batch File Specification

Axuall can programmatically create wallets for clinician populations at a health system. This is a common use case when onboarding large clinician populations outside of initial or re-appointment cycles.

Axuall does this by ingesting batch files with Clinician information via an agreed upon secure transfer protocol. The specification for these files is listed below:

📘
Specialty Information
Axuall does not ingest Specialty information in the batch files below - all specialty information is determined by pulling active specialty board certifications for a clinician.
Axuall does not support the programmatic ingestion of clinicians who do not have specialty board certifications. This can only be supported via engagement with clinicians since the collection of additional information is necessary ( Board eligibility, Pending Results, Exam Dates)

Batch File Fields

Type	Column Name	Example	Notes	Required/Optional
First Name	first_name	Jane		Required
Middle Name	middle_name	Marie		Required
Last Name	last_name	Doe		Required
Aliases	aliases	Jane\|Maria\|Diaz;Jane\|\|Lee	- Each name is delimited by a `;` character - Use a `\|` to delimit the following parts of each name `first`, `middle`, `last`	Required
Degree	degree	MD		Required
Social Security Number	social_security_number	111111111	Do not include any dashes	Required
Date of Birth	date_of_birth	01/01/1950	The required format is `mm/dd/YYYY`	Required
Email Address	email_address	[email protected]		Required
NPI	npi	1234567890	The NPI is used as the primary identifier for most onboarded clinicians This is subject to change as we consider clinicians who may not have an NPI.	Required for non-RN clinicians. RNs may have NPI and/or NCSBN
NCSBN	ncsbn	35256363	The NCSBN number is used as the primary identifier for RNs. However, if an RN has an NPI, they may use that instead.	RN clinicians must have either an NCSBN or NPI to be loaded.
State Licenses	state_licenses	OH\|123456;PA\|123456	- `\|` is used to delimit 2 letter state code from the license number - `;` is used to delimit multiple state licenses	Required
RN Licenses	rn_licenses	OH\|RN123456;PA\|RN123456	- `\|` is used to delimit 2 letter state code from the license number - `;` is used to delimit multiple state licenses	Optional
DEA Licenses	dea_licenses	OH\|123456;PA\|123456	- `\|` is used to delimit 2 letter state code from the license number - `;` is used to delimit multiple DEA licenses	Required
Facilities	facilities	Facilty1;Facility2	- `;` is used to delimit Facilities If your health system is set up with multiple facilities, these names must be established on initial integration with Axuall.	Required
Address	home_address	123 Euclid Ave.		Required
Address City	home_city	Cleveland		Required
Address State	home_state	OH		Required
Address ZIP	home_zip	44114		Required
American Heart Association Certifications	aha_certifications	12334567880	- `;` is used to delimit multiple AHA ecard numbers
Recipe Name	recipe_name	Atlas Health APRN Initial Appointment	Recipe names and types will be established on initial integration with Axuall. Please reach out to your health system's Axuall representative for a list of available recipes or see the recipe list on the invite screen of the admin portal.	Optional
Enrollment Type	enrollment_type	Initial Appointment	Allowed values: Initial Appointment, Continuous Monitoring, Re-appointment	Optional
Graduate NSC Education	graduate_nsc	003024\|Case Western Reserve University	- `\|` is used to delimit the NSC school code from the NSC institution name	Optional
Undergraduate NSC Education	undergraduate_nsc	003050\|John Carroll University	- `\|` is used to delimit the NSC school code from the NSC institution name	Optional
Non-MD/DO Board Certifications	board_certifications	aanp\|1234567;nbcrna\|12345678	Currently Supported Board Types: aacn, ancc, aanp, nbcrna, nccpa, ncc - `\|` is used to delimit the board acronym from the board number - `;` is used to delimit multiple board certification pairs.	Optional
Tag Name	tag_name	Reappt March 2023	-For clinicians who do not need a tag, leave the tag_name field blank	Optional (Required if Tag Color is defined)
Tag Color	tag_color	red	Color Options: red light-red yellow light-yellow green light-green blue light-blue indigo light-indigo violet light-violet gray light-gray -For clinicians who do not need a tag, enter 'n/a' for the color.	Optional (Required if Tag Name is defined)