Overview
This document outlines the specifications for extracting and delivering healthcare-related data entities from source systems to clients. The extracted data encompasses patient demographics, insurance details, provider information, appointments, and clinical indices among others. Data is delivered securely via SFTP.
Extracted Data Entities
The following data entities can be extracted:
- Patients: Patient demographic information
- Patient Insurances: Insurance details for each patient
- Providers: Information about healthcare providers
- Fees: Fee structures for various services
- Facilities: Details about healthcare facilities
- Referring Providers: Information about providers who refer patients
- Insurances: Insurance plans and details
- Charges: All charges which are created along with Date of service.
- Payments: Details of all the Payments posted in the system
- Employers: Employer information for patients
- Appointments: Scheduled appointments for patients
- EHR Charts Index (EHR CHARTS INDX): Index of Electronic Health Records
- Patient Documents Index (patient_docs_indx): Index of patient documents
- CCDA (Consolidated Clinical Document Architecture)
File Format
- CSV (Comma Separated Values) file format for data entities 1-11
- Patient Documents: Provided in their original format, as uploaded by clients.
- EHR Charts: Provided in HTML format.
- CCDA: XML file format
File Naming Convention
Each data entity is stored in a separate file, named as follows:
- patients.csv
- patient_insurances.csv
- providers.csv
- fees.csv
- facilities.csv
- referring_providers.csv
- insurances.csv
- employers.csv
- appointments.csv
- charges.csv
- payments.csv
- ehr charts indx.csv
- patient_docs_indx.csv
Patient Documents
- Stored in their original format under folder name “patient_docs” (e.g., PDF, DOCX, JPEG, etc.)
- File names will match the corresponding index in patient_docs_indx.csv in which column header “NEW FILE NAME” needs to be referred for file name. EHR Charts Provided in HTML format under folder name “ehr_charts”
- Each chart is stored in a separate HTML file
- File names will match the corresponding index in ehr_charts_indx.csv
Crosswalk Details
| Source File | Source Column | Target File | Target Column |
|---|---|---|---|
| patients.csv | MEDICAL_RECORD_NUM | patient_docs_indx.csv | MR# |
| patients.csv | MEDICAL_RECORD_NUM | EHR_CHARTS_INDX.csv | MR# |
| patients.csv | MEDICAL_RECORD_NUM | appointments.csv | MEDICAL_RECORD_NUM |
| patients.csv | MEDICAL_RECORD_NUM | patient_insurances.csv | MEDICAL_RECORD_NUM |
| patients.csv | EMPLOYER_ID | employers.csv | EMPLOYER_ID |
| patients.csv | MEDICAL_RECORD_NUM | charges.csv | MEDICAL_RECORD_NUM |
| patients.csv | MEDICAL_RECORD_NUM | payments.csv | MEDICAL_RECORD_NUM |
Master Data Files
The following files contain master information for the database:
- Fees.csv
- Facilities.csv
- Referring_providers.csv
- Providers.csv
- Insurances.csv
These files do not require cross walking to other files for data validation.
Data Delivery Mechanism via SFTP
-
- Step-by-Step Process for Data Delivery via SFTP
– The client is required to provide the IP address(es) from which they will access and download the data.
– This IP address must be whitelisted to secularly access SFTP. - IP Whitelisting
– The provided client IP address is whitelisted on the organization’s SFTP server.
– Whitelisting ensures that SFTP access is granted only from the specified IP address(es), enhancing security.
– Whitelisting is enabled for a limited period to permit data extraction. - SFTP Credential Generation and Sharing
– Once the IP whitelisting is completed, SFTP credentials are generated for the client.
– These credentials are shared with the client through a secured method using our secured messaging platform. - Client Access and Data Download
– The client uses the shared SFTP credentials to access the designated SFTP path.
– Data is made available at a predefined path on the SFTP server for the client to download.
– Access is available exclusively for the whitelisted IP address(es).
- Step-by-Step Process for Data Delivery via SFTP
Data Availability and Retention
- Availability Period: The data will be available for download on the SFTP server for 15 days from the date of upload.
- Download Requirement: Clients must download the data within this 15-day period.
- Post-Retention: After 15 days, the data will be permanently removed from the SFTP server and will no longer be accessible.
Was this helpful?
Thanks for your feedback!