Supported Transfer Protocol
FormDr supports SFTP (Secure File Transfer Protocol) for HL7 exports.
You can configure the connection using either:
SSH key file, or
Username and password credentials.
This integration is compatible with any provider that supports HL7 v2.x.
Accessing HL7 Configuration
- From the main menu, go to Integrations.
(Navigation: Main Menu → Integrations)
2. Open the HL7 configuration tile and select the forms you want to include in the export.
You can also define the export frequency (e.g., daily, weekly, or custom schedule).
SFTP Configuration
Enter your SFTP connection details, including:
- Host address
- Port
- Username and password or key file
Provider and Receiver Information
Next, set up the default provider and receiver details for the HL7 message:
Provider Info: Information about your practice or sending entity
- Receiver Info: Details about the system or organization receiving the data
Exporting HL7 Data
Once all configuration details are saved, FormDr will:
Automatically generate the HL7 file on the selected schedule, and
Deliver it to your configured SFTP directory.
You can also manually trigger an export at any time:
Test Connection: Verify that your SFTP credentials are valid and the folder is accessible.
Export Now: Immediately generate and send the HL7 file without waiting for the next scheduled run.
File Format
FormDr supports data export in HL7 v2.x format, following industry-standard specifications for healthcare data exchange.
Below is an example of a sample HL7 file generated by the FormDr platform:
MSH|^~\&|SendingApp|SendingFacility|ReceivingApp|ReceivingFacility|Prod(P)or
Test (T)||ORU^R01|||
PID|1|PatientSSD or Id
Num.|||PatientLastN^PatientFirstN|PatientMothersName|DOBYYYYMMDD|sex|alias|race|street^other^city^state^zip^country|
PV1|1|O|||||ProviderNPI^ProviderLastN^ProviderFirstN|
TXA|1|ReportUUID^ReportName|AP||ProviderId^ProviderMnemonic|CurrentDateYYYYMMDD|ResultDate-YYYYMMDD|||||ReportUUID|||||IP|
OBX|1|ED|PDFReport||^^^^base64-pdf-file-content-here
OBX|2|ST|Text|height|[[patientHeight]]|
OBX|3|ST|Text|weight|[[patientWeight]]|
OBX|4|ST|Text|BMI|[[patientBMI]]|
OBX|5|ST|Text|bloodPressure|[[patientBP]]|
OBX|6|ST|Text|heartRate|[[patientBPM]]|
OBX|7|ST|Text|spO2|[[patientSpO2]]|
OBX|8|ST|Text|pulseRate|[[patientPulse]]|
OBX|9|ST|Text|temperature|[[patientTemp]]|
Spec Table
HL7 section | Description |
| MSH | Message header |
| PID | Patient info |
| PV1 | Provider info |
| TXA | Provider and Report Data |
| OBX | PDF data |
HL7 MSH attributes | Description | Additional info |
| MSH.2 | ^~\& | |
| MSH.3 | Sending app | |
| MSH.4 | Sending Facility | Inside FormDr facility is like a Practice. |
| MSH.5 | Receiving app | |
| MSH.6 | Receiving Facility | |
| MSH.10 | Production or Test | P for prod T for test |
| MSH.11 | EMPTY | |
| MSH.12 | ORU^R01 | |
| MSH.13 | EMPTY | MSH.14 |
| MSH.14 | EMPTY |
HL7 PID attributes | Description | Additional info |
| PID.1 | 1 | |
| PID.2 | Patient Id or SSN | |
| PID.3 | EMPTY | |
| PID.4 | EMPTY | |
| PID.5 | Patient First and Last name | LastName^FirstName |
| PID.6 | Patient mothers name | |
| PID.7 | DOB | YYYYMMDD |
| PID.8 | sex | |
| PID.9 | alias | |
| PID.10 | race | |
| PID.11 | address^address1^city^state^zip^country |
HL7 PV1 attributes | Description | Additional information |
| PV1.1 | 1 | |
| PV1.2 | O | patient class |
| PV1.3 | EMPTY | |
| PV1.4 | EMPTY | |
| PV1.5 | EMPTY | |
| PV1.6 | EMPTY | |
| PV1.7 | ProviderNPI^ProviderLastName^ProviderFirstName |
HL7 TXA attributes | Description | Additional info |
| TXA.1 | 1 | |
| TXA.2 | ReportUUID^ReportName | |
| TXA.3 | AP | Other application data, typically uninterpreted binary data HL7 V2.3 and later |
| TXA.4 | EMPTY | |
| TXA.5 | ProviderId^ProviderMnemonic | |
| TXA.6 | Current Date | YYYYMMDD |
| TXA.7 | Report Date | YYYYMMDD |
| TXA.8 | EMPTY | |
| TXA.9 | EMPTY | |
| TXA.10 | EMPTY | |
| TXA.11 | EMPTY | |
| TXA.12 | Report UUID | |
| TXA.13 | EMPTY | |
| TXA.14 | EMPTY | |
| TXA.15 | EMPTY | |
| TXA.16 | EMPTY | |
| TXA.17 | IP | Document completion status more |
HL7 OBX attributes | Description | Additional info |
| OBX.1 | 1 | |
| OBX.2 | ED | Encapsulated Data |
| OBX.3 | PDFReport | Observation Identifier |
| OBX.4 | EMPTY | |
| OBX.5 | ^^^^pdf content | ^^^^ means that it is on OBX.5.4 instead OBX.5 |
Field Naming / Placeholders
Once you named a form field as one of the following place holders, the FormDr routines will be able to pick up the field value and inject it inside the generated HL7.
Supported fields:
Field | Name |
| Patient SSN | ssn |
| Patient Date of Birth | dateofBirth |
| Address | address |
| Address2 | address2 |
| City | city |
| State | state |
| Country | country |
| Zip code | zip |
| Alias/Preferred name | preferredName |
| Sex | sex |
| Mothers name | mothersname |
| Race | race |
| Height | patientHeight |
| Weight | patientWeight |
| BMI | patientBMI |
| Blood Pressure | patientBP |
| BPM | patientBPM |
| SpO2 | patientSpO2 |
| Pulse Rate | patientPulse |
| Temperature | temperature |
