Template Explanations
Note: Ensure all imports use the UTC time format.
Generic patient import
Template download: Patient Import Template
The patient CSV file must contain the following fields or a subset of them:
Note: ProjectName is not required, but highly recommended.
|
Name |
Type |
Required |
Description |
|
ExternalID |
Alphanumeric |
Yes |
This field is a unique identifier for the patient being tested. It is used to link this specific patient to audiograms generated or uploaded with the same ExternalID. |
|
LastName |
Alphanumeric |
Yes |
Last name |
|
FirstName |
Alphanumeric |
Yes |
First name |
|
MI |
Alphanumeric |
No |
Middle name or initial |
|
Sex |
Alphanumeric |
Yes |
Use M or F character here. This field is required for proper OSHA and/or MSHA calculations where age correction is applied. |
|
BirthDate |
Date |
Yes |
Birth Date |
|
HireDate |
Date |
No |
Hire Date |
|
|
Alphanumeric |
No |
Email address |
|
TestDate |
Date |
No |
Date of most recent hearing test |
|
CellPhone |
Alphanumeric |
No |
Phone number |
|
Addr1 |
Alphanumeric |
No |
Address Line 1 |
|
Addr2 |
Alphanumeric |
No |
Address Line 2 |
|
Addr3 |
Alphanumeric |
No |
Address Line 3 |
|
City |
Alphanumeric |
No |
Address City |
|
State |
Alphanumeric |
No |
Address State / Province |
|
Country |
Alphanumeric |
No |
Address Country |
|
Zip |
Alphanumeric |
No |
Zip or Postal Code |
|
School |
Alphanumeric |
No |
School Name |
|
JobClassification |
Alphanumeric |
No |
Job Classification/Name |
|
Company |
Alphanumeric |
No |
Company name |
|
EmployeeNumber |
Alphanumeric |
No |
Employee number |
|
Facility |
Alphanumeric |
No |
Facility or location |
|
Department |
Alphanumeric |
No |
Department |
|
JobPosition |
Alphanumeric |
No |
Job Position (sometimes considered to be the next level of detail under the JobClassification) |
|
Status |
Alphanumeric |
No |
Active or Inactive status. Accepted values are A, I, Active, Inactive |
|
ActiveDate |
Date |
No |
Date where employee was last active in the hearing conservation program |
|
ProjectName |
Alphanumeric |
No |
Name of the project containing the employee |
Generic Audiogram import
Template download: Audiogram Import Template
|
Name |
Type |
Required |
Description |
|
TestGuid |
Alphanumeric |
No |
Input the unique TestID from your historical data if available, otherwise leave this field blank. |
|
ExternalId |
Alphanumeric |
Yes |
This field is a unique identifier for the patient being tested. It is used to link this audiogram record to the specific patient with the same ExternalID. The patient must be uploaded prior to the audiograms being uploaded. |
|
TestDate |
Date |
Yes |
Test Date |
|
TestTime |
Time |
No |
supported time formats: (24 hour) hh:mm:ss, hh:mm, hhmmss, hhmm (12 hour) hh:mm:ss am/pm, hh:mm am/pm |
|
Examiner |
Alphanumeric |
No |
Examiner name |
|
LeftBaseline |
Y/N |
No, but required for shift calculations |
Use Y to indicate it is the baseline. An empty cell or N indicates that it is not the Left Ear Baseline audiogram. |
|
RightBaseline |
Y/N |
No, but required for shift calculations |
Use Y to indicate it is the baseline. An empty cell or N indicates that it is not the Right Ear Baseline audiogram. |
|
Comment |
Alphanumeric |
No |
Maximum 256 characters : Audiogram comments |
|
TransducerModel |
Alphanumeric |
No |
Transducer Model |
|
TransducerSerial |
Alphanumeric |
No |
Transducer Serial |
|
AudiometerModel |
Alphanumeric |
No |
Audiometer Model |
|
AudiometerSerial |
Alphanumeric |
No |
Audiometer Serial |
|
CalibrationDate |
Date |
No |
Calibration Date |
|
LeftThresh<frequency> |
Numeric |
No |
Left threshold for specified frequency. Valid frequencies are: 250|500|750|1000|1500|2000|3000|4000|6000|8000|10000|12500|16000. Example: LeftThresh1000 represents the Left Ear Threshold at 1000Hz. For No Response, use NR. For Not Tested, use NT or leave empty |
|
RightThresh<frequency> |
Numeric |
No |
Right threshold for specified frequency. Valid frequencies are: 250|500|750|1000|1500|2000|3000|4000|6000|8000|10000|12500|16000 For No Response, use NR. For Not Tested, use NT or leave empty |
Benson patient import
Template download: Benson Patient Import Template
|
Name |
Type |
Required |
Description |
|
SubjectGuid |
Alphanumeric |
Yes |
This field is a unique identifier for the patient being tested. It is used to link this specific patient with audiogram results with the same SubjectGuid. |
|
LastName |
Alphanumeric |
Yes |
Last name |
|
FirstName |
Alphanumeric |
Yes |
First name |
|
MI |
Alphanumeric |
No |
Middle name |
|
Sex |
Alphanumeric |
Yes |
Use M or F character here. This field is required for proper OSHA and/or MSHA calculations where age correction is applied. |
|
BirthDate |
Date |
Yes |
Birth Date, format should be YYYYMMDD or YYYY-MM-DD |
|
HireDate |
Date |
No |
Hire Date, format should be YYYYMMDD or YYYY-MM-DD |
|
|
Alphanumeric |
No |
Email address |
|
TestDate |
Date |
No |
Date of most recent hearing test, format should be YYYYMMDD or YYYY-MM-DD |
|
CellPhone |
Alphanumeric |
No |
Phone number |
|
Addr1 |
Alphanumeric |
No |
Address Line 1 |
|
Addr2 |
Alphanumeric |
No |
Address Line 2 |
|
Addr3 |
Alphanumeric |
No |
Address Line 3 |
|
City |
Alphanumeric |
No |
Address City |
|
State |
Alphanumeric |
No |
Address State / Province |
|
Country |
Alphanumeric |
No |
Address Country |
|
Zip |
Alphanumeric |
No |
Zip or postal code |
|
School |
Alphanumeric |
No |
School Name |
|
JobClassification |
Alphanumeric |
No |
Job Classification/Name |
|
Company |
Alphanumeric |
No |
Company name |
|
EmployeeNumber |
Alphanumeric |
No |
Employee number |
|
Facility |
Alphanumeric |
No |
Facility or location |
|
Department |
Alphanumeric |
No |
Department |
Benson Audiogram import
Template download: Benson Audiogram Import Template
|
Name |
Type |
Required |
Description |
|
TestGuid |
Alphanumeric |
No |
Input the unique TestID from Benson historical data if available, otherwise leave this field blank. |
|
SubjectGuid |
Alphanumeric |
Yes |
This field is a unique identifier for the patient being tested. It is used to link this audiogram record to the specific patient with the same SubjectGuid. |
|
TestType |
Numeric |
No |
Test type code meaning: 126: Left and Right baseline 6 or 38: Left baseline 24 or 88: Right baseline |
|
TestDate |
Date |
Yes |
Test Date in format: YYYYMMDD or YYYY-MM-DD |
|
TestTime |
Time |
No |
HHMMSS: Test time in 24 hour format |
|
Comment |
Alphanumeric |
No |
Maximum 256 characters : Audiogram comments |
|
LeftThresh<frequency> |
Numeric |
No |
Left threshold for specified frequency. Valid frequencies are: 250|500|750|1000|1500|2000|3000|4000|6000|8000|10000|12500|16000. Example: LeftThresh1000 represents the Left Ear Threshold at 1000Hz For No Response, use NR. For Not Tested, use NT or leave empty |
|
RightThresh<frequency> |
Numeric |
No |
Right threshold for specified frequency. Valid frequencies are: 250|500|750|1000|1500|2000|3000|4000|6000|8000|10000|12500|16000 For No Response, use NR. For Not Tested, use NT or leave empty |
|
Last Updated: 2023-04-19 |
|
|
| Next Topic: File Format Notes→ |