Electronic Health Information export
The format and structure of the EHI export — archive layout, CSV conventions, how the files relate, and the full column reference.
| Field | Value |
|---|---|
| Product name | Maximus |
| Product version | 1.0 |
| Developer | MaxRemind Inc. |
| Certification number | 15.05.05.3173.MAXR.01.00.1.231031 |
| Date created | 20 September 2023 |
| Date updated | 16 November 2026 |
1. Purpose and scope
This document describes the format and structure of the electronic health information (EHI) that Maximus EHR exports, in satisfaction of ONC certification criterion §170.315(b)(10). Its audience is a data engineer at a receiving organisation who has not seen this system before.
It covers what the export contains, how the files relate to one another, and how to interpret them. It is kept current with the software; the revision date above is the date of the last change.
2. Single patient export
A user may export the complete EHI held for a single patient at any time, without assistance from the developer, from within the Maximus EHR application. The export is produced as an HL7 C-CDA R2.1 document covering the USCDI v3 data classes, described in §5.
No request to MaxRemind, no fee and no scheduling is required. The function is available to any user with access to the patient's chart.
3. Patient population export
The complete EHI held for a practice's entire patient population can be exported by two routes, described in §6 and §7. Population export is restricted to an authorised administrative user.
4. Export formats
Three export routes are available. They are complementary rather than alternatives: the C-CDA and FHIR routes are standards-based and carry the USCDI data classes, while the full practice archive carries everything the practice holds, including data that has no representation in either standard.
| Format | Scope | Output | Typical use | |
|---|---|---|---|---|
| A | C-CDA document export | Single patient, and batch | HL7 C-CDA R2.1 XML | Transition of care, patient-requested copy, single-patient EHI export |
| B | FHIR Bulk Data Access | Patient population (Group-level) | NDJSON (application/fhir+ndjson) | Standards-based population export to another FHIR-capable system |
| C | Full practice data archive | Entire practice | ZIP containing CSV, documents and attachments | Complete handover of everything the practice holds, including data with no FHIR or C-CDA representation |
5. Format A — C-CDA document export
Maximus produces HL7 Consolidated CDA (C-CDA) Release 2.1 XML documents conforming to the USCDI v3 data classes. This is the route used for single-patient export and for transitions of care.
- Document templates follow the HL7 CDA R2 IG: Consolidated CDA Templates for Clinical Notes, Release 2.1 (US Realm).
- Companion guidance follows the C-CDA Templates for Clinical Notes STU Companion Guide, Release 4.1 (US Realm).
- Output is XML, one document per patient.
6. Format B — FHIR Bulk Data Access
Population-level export is also available through the FHIR API as an asynchronous bulk export, following the HL7 FHIR Bulk Data Access (Flat FHIR) Implementation Guide, version 2.0.0 (STU 2).
/$export or Patient-level $export.| Step | Request | Response |
|---|---|---|
| 1. Kick off | GET [base]/Group/{groupId}/$export with Prefer: respond-async | 202 Accepted with a Content-Location polling URL |
| 2. Poll | GET [base]/$export-poll-status?… | 202 while in progress; 200 with a manifest when complete |
| 3. Download | GET each manifest output.url | application/fhir+ndjson, one resource per line |
Supported kick-off parameters are _type, _since and _outputFormat. Exported resources conform to US Core 6.1.0. Bulk export requires a system/ scope obtained through the SMART Backend Services flow.
The FHIR API, its authorisation model and its full resource reference are documented separately at https://documents.maximus.care/.
7. Format C — full practice data archive
The complete data set held for a practice is exported as a single ZIP archive. This is the most complete of the three routes: it carries every exported table as CSV, together with the practice's scanned and uploaded files.
7.1 Archive structure
practice_{practice_id}_export_{timestamp}.zip
|
+-- csv/ 32 CSV files, one per source table
+-- documents/ patient documents, one folder per patient
| PID_FirstName_LastName_DOB/
+-- attachments/ files attached to a module of a visit,
| one folder per (patient, encounter, module)
|
+-- manifest.csv what was exported, by whom, when, and the
| row count of every CSV
+-- README.txt the same guidance as this document, shipped
| inside the archive
+-- documents_missing.csv present ONLY if a document could not be copied
+-- attachments_missing.csv present ONLY if an attachment could not be copied
documents/ and attachments/ are different things and are filed differently. A patient document belongs to the person. An attachment belongs to one module of one visit — a wound photograph, a file clipped to a referral. Neither is a subset of the other.7.2 CSV conventions
These apply to every file under csv/. The quoting rule in particular affects whether identifiers survive import intact.
| Property | Behaviour |
|---|---|
| Encoding | UTF-8 with a byte-order mark. The BOM is present so that Excel on Windows opens the files correctly. Most CSV libraries strip it automatically; if the first column name arrives with three stray bytes in front of it, that is the BOM. |
| Line endings | CRLF. |
| Quoting | Every field is quoted, without exception. Identifiers such as SSNs, policy numbers and ZIP codes are digit strings, not numbers, and an unquoted import strips their leading zeros. Import every column as text and cast afterwards. A literal double quote inside a value is doubled (""). |
| Blank cells | A blank means the practice held no value. It never means zero, and the literal text null never appears. |
| Dates | ISO 8601: yyyy-MM-dd, or yyyy-MM-dd HH:mm:ss where a time of day was recorded. Not US mm/dd/yyyy. |
| Embedded line breaks | Free-text columns — clinical notes, comments, HPI, progress notes — legitimately contain line breaks inside a quoted field. This is valid CSV per RFC 4180, but a naive line-by-line parser will corrupt it. Use a conformant CSV parser. |
| Row order | Deterministic. Repeat exports of unchanged data are byte-identical, so two archives can be compared directly. |
7.3 How the files relate
Two identifiers connect almost everything.
patient_id— one person. The master key. It appears in nearly every file and always means the same person. Start here.chart_id— one encounter: a single visit on a single date. Anything recorded during a visit carries thechart_idof that visit.
patients.csv (one row per person, keyed by patient_id) | +-- patient_charts.csv (one row per visit, keyed by chart_id) | | | +-- everything recorded during that visit: | chart_reason_for_visit_hpi chart_assessment | chart_vital chart_care_plan | chart_blood_pressure chart_procedures | chart_prescription chart_progress_note | chart_socialhistory patient_medical_history | chart_familyhistory patient_followup | patient_education_resources patient_orders | the four wound_* files chart_narrative_export | +-- chart_allergies.csv (keyed by patient_id only - not per visit) +-- appointment.csv (the schedule, not the visit) +-- claim.csv (billing; claim_diagnos, claim_procedure, | claim_payment hang off claim_id) +-- patient_document.csv (link -> documents/)
7.4 File index
Grain is what one row represents. Keys is how to join it.
| File | Grain — one row is | Keys |
|---|---|---|
patients.csv | one patient | patient_id — master key |
patient_charts.csv | one encounter / visit | chart_id, patient_id |
chart_reason_for_visit_hpi.csv | chief complaint and HPI | chart_id, patient_id |
chart_assessment.csv | one diagnosis | chart_id, patient_id |
chart_care_plan.csv | one care plan entry | chart_id, patient_id |
chart_procedures.csv | one procedure / CPT | chart_id, patient_id |
chart_progress_note.csv | one progress note | chart_id, patient_id |
chart_prescription.csv | one prescription | chart_id, patient_id |
chart_vital.csv | one vitals set | chart_id, patient_id |
chart_blood_pressure.csv | one BP reading | chart_id, patient_id |
chart_socialhistory.csv | social history | chart_id, patient_id |
patient_medical_history.csv | one history note | chart_id, patient_id — history_type says which history |
chart_familyhistory.csv | one relative-and-condition pair | chart_id, patient_id |
patient_followup.csv | one follow-up asked for | chart_id, patient_id — a plan, see §9 |
patient_education_resources.csv | one item of material given | chart_id, patient_id |
chart_allergies.csv | one allergy | patient_id only |
chart_narrative_export.csv | ROS or Physical Exam for one encounter | chart_id, patient_id — module_name says which |
patient_orders.csv | one order / test / result combination | order_id, test_id, chart_id, patient_id |
patient_wound.csv | one wound | id, patient_id |
chart_wound.csv | one wound per visit | id, wound_id, chart_id |
patient_wound_detail.csv | one wound finding | wound_id, chart_wound_id |
wound_debridement.csv | one debridement | chart_id, patient_id |
wound_procedure_template.csv | one wound procedure | chart_id, patient_id |
wound_cellular_tissue_product_utilized.csv | one product use | chart_id, patient_id |
wound_skin_substitute_product_utilized.csv | one product use | chart_id, patient_id |
appointment.csv | one booked appointment | appointment_id, patient_id — no chart_id |
claim.csv | one claim | claim_id, patient_id |
claim_diagnos.csv | one diagnosis billed | claim_id |
claim_procedure.csv | one procedure billed | claim_id |
claim_payment.csv | one payment or adjustment | claim_id |
patient_document.csv | one patient document | patient_id, link → documents/ |
patient_chart_attachment.csv | one file attached to a module of a visit | chart_id, patient_id, url → attachments/ |
7.5 Column reference
Columns are listed in the order they appear in the file. 32 files, 392 columns in total. This section is generated directly from the exporting code.
appointment.csv
12 columns
appointment_id patient_id appointment_date appointment_time appointment_duration location_id location_name provider_id provider_name apptype apptype_description is_televisit
chart_allergies.csv
9 columns
patient_id description status severity alergy_date rxnorm code_type reaction_desc type_desc
chart_assessment.csv
9 columns
patient_id chart_id code description date notes condition_type diag_type sequence_no
chart_blood_pressure.csv
8 columns
patient_id chart_id monitoringposition_bp systolic_bp diastolic_bp pulse character rhythm
chart_care_plan.csv
9 columns
patient_id chart_id plan_type code description code_type instruction date notes_text
chart_familyhistory.csv
5 columns
patient_id chart_id relation icd_code description
chart_narrative_export.csv
5 columns
patient_id chart_id module_name content_html content_text
chart_prescription.csv
15 columns
patient_id chart_id drug_name drug_info issued_date strength take dosage_form route dosage_frequency quantity status archive sig_text external_source
chart_procedures.csv
13 columns
chart_id patient_id procedure_code description comments unit procedure_date code_type entry_type mod1 mod2 mod3 mod4
chart_progress_note.csv
4 columns
chart_id patient_id notes_html notes_text
chart_reason_for_visit_hpi.csv
4 columns
chart_id patient_id reason_detail hpi_detail
chart_socialhistory.csv
54 columns
patient_id chart_id marital_status sexual_orientation children education occupation drug_use exercise seatbelt exposure smoking_status tobacco_type packs_per_day year_started alcohol_per_day caffeine_per_day age_at_menarche cycle flow gravida pregnant edd lmp dysmenorrhea comment para smoking_snomed not_performed smoking_end_date smoking_start_date year_of_menopause etoh tobacco_cessation home_environment diet_education quit_date gender_identity drug_substance drug_substance_other drug_substance_last_used_date drug_substance_quantity diet_education_other tobacco_cessation_other pregnancy_intent_desc pregnancy_status_code pregnancy_status_desc pregnancy_intent_answer_code pregnancy_intent_answer_desc occupation_desc industry_code industry_desc occupation_start_date occupation_end_date
chart_vital.csv
37 columns
patient_id chart_id height_feet height_meters weight_kg weight_lbs bmi respiration temperature_fahren temperature_centi temperature_source head_circumference_inch head_circumference_cm oxygen_saturation room no_of_liters reading_delay pain comments lmp pregnancy strip blood pr_bpm height_cm waist oxygen_at_home oxygen_source oxygen_flow waist_in pulse_oximetry waist_cm bmi_percentile headcircumference_percentile weightforlength_percentile pain_location oxygen_concentration
chart_wound.csv
6 columns
id patient_id chart_id wound_id status wound_resolved_date
claim.csv
20 columns
claim_id patient_id dos pos pri_status sec_status pat_status pri_paid sec_paid patient_paid claim_total amt_paid location_id location_name billing_physician billing_physician_name attending_physician attending_physician_name amt_due claim_status
claim_diagnos.csv
4 columns
claim_id patient_id diag_code description
claim_payment.csv
13 columns
claim_id patient_id payment_source charged_procedure paid_procedure check_date check_number paid_amount adjusted_amount allowed_amount deductable_amount coinsurance_amount copay_amount
claim_procedure.csv
10 columns
claim_id patient_id proc_code description pos charges unit total_charges dos_from dos_to
patient_chart_attachment.csv
5 columns
patient_id chart_id name url module_type
patient_charts.csv
9 columns
chart_id visit_date patient_id provider_name location_name signed signed_date visit_type pos_id
patient_document.csv
4 columns
patient_id document_date name link
patient_education_resources.csv
5 columns
patient_id chart_id module_name title notes_text
patient_followup.csv
4 columns
patient_id chart_id followup_date notes
patient_medical_history.csv
4 columns
patient_id chart_id history_type notes
patient_orders.csv
19 columns
order_id chart_id patient_id order_date status bill_type order_type lab_id test_id proc_code proc_description observation_datetime result_code result_description result_value result_value_unit recomended_value result_status abnormal_range
patient_wound.csv
7 columns
id patient_id wound_location wound_location_direction status wound_number wound_resolved_date
patient_wound_detail.csv
8 columns
wound_id chart_wound_id description description_value1 description_value2 comments deleted seq_no
patients.csv
28 columns
patient_id first_name mname last_name gender dob ssn zip city state address address2 marital_status home_phone work_phone cell_phone email patient_status gender_identity sexual_orientation Race Ethnicity Pri_Insurance Pri_policy_number Pri_relationship sec_Insurance sec_policy_number sec_relationship
wound_cellular_tissue_product_utilized.csv
14 columns
patient_id chart_id product_utilized product_size application_no lot_number serial_no expiration_date amount_utilized amount_wasted exposed_tendon_muscle total_cpt_amount_utilized other_info medical_necessity
wound_debridement.csv
22 columns
chart_id patient_id location type pre_debridement_wound_measurement pre_debridement_wound_area post_debridement_wound_measurement post_debridement_wound_area debridement_reason instrument_scalpel instrument_blade_10 instrument_blade_11 instrument_iris_scissors instrument_adson_forceps instrument_dermal_curette debrided_tissue_depth anesthesia_used blood_loss post_debridement_dressing procedure_summary other_info medical_necessity
wound_procedure_template.csv
12 columns
patient_id chart_id location wound_measurement procedure_reason procedure_code procedure_desciption procedure_code_type silver_nitrate_sticks_used post_cauterization_dressing_type patient_response other_info
wound_skin_substitute_product_utilized.csv
14 columns
patient_id chart_id product_utilized product_size application_no lot_number serial_no expiration_date amount_utilized amount_wasted exposed_tendon_muscle total_substitute_utilize skin_substitute_other other_info
7.6 Documents
documents/ holds the practice's scanned and uploaded patient documents as their original files — signed progress notes, lab results, radiology reports, and anything else uploaded to a patient's record.
- One folder per patient, named
PID_FirstName_LastName_DOB. patient_document.csvis the index. Itslinkcolumn gives the file's location withindocuments/.- If
documents_missing.csvis absent, every document listed inpatient_document.csvis present in the archive.
7.7 Attachments
attachments/ holds files attached to a module of a visit rather than to the person — a wound photograph taken at an encounter, a file clipped to a referral.
- One folder per (patient, encounter, module).
patient_chart_attachment.csvis the index. Itsurlcolumn gives the file's location withinattachments/.- If
attachments_missing.csvis absent, every attachment listed inpatient_chart_attachment.csvis present.
7.8 manifest.csv and verifying completeness
manifest.csv records what was exported, by whom, when, for which practice, and the row count of every CSV. It is the receiving organisation's means of confirming the handover arrived intact.
chart_narrative_export.csv, whose rows are rendered rather than read from a table; the manifest carries narrative_build_failed and narrative_build_skipped_no_content alongside it so that the two causes can be told apart.Reconcile your loaded row counts against manifest.csv before relying on the data or decommissioning any source system. If they differ, stop and raise it.
7.9 Missing-file reports
documents_missing.csv and attachments_missing.csv are present only when something could not be copied, so their very existence is the signal. Each lists the affected records and the reason. They are kept as separate files because the two are keyed differently — a document id versus an attachment id — and merging them would leave neither usable for lookup.
8. Suggested order of loading
patients.csv— establishes everypatient_idpatient_charts.csv— establishes everychart_idpatient_wound.csv, thenchart_wound.csv- Everything else, in any order
patient_document.csv, then attach the files fromdocuments/- Reconcile your row counts against
manifest.csvbefore relying on the load
9. Interpreting the data
The following are characteristics of the source system rather than faults in the export. They are listed because each one has the potential to be misread, and a handover that is misread is worse than one that is incomplete.
Column names that look misspelled
Three columns are misspelled in the source database and are exported exactly as stored, so that they match any mapping document supplied alongside: alergy_date in chart_allergies.csv (one l), recomended_value in patient_orders.csv (one m), and procedure_desciption in wound_procedure_template.csv (missing r).
Entirely empty columns
A few columns exist in some installations of this EHR and not others. Where a column was absent from a practice's database it is still present in the CSV but blank for every row, so the column layout is identical for every export. Affects some columns in chart_socialhistory.csv, chart_vital.csv, chart_care_plan.csv and patient_wound.csv.
Repeated rows in patient_orders.csv
This file is three tables flattened into one: the order, the tests on it, and the results of those tests. An order with three tests appears on three rows; a test with four results appears on four. The order columns repeat down those rows. A test with no result yet still appears once, with the result columns blank.
patient_wound_detail.csv is the only file containing deleted records
It carries a deleted column and the export preserves it. deleted = 1 means the finding was retracted; deleted = 0 means it stands. Every other file contains active records only.
appointment.csv includes cancelled and no-show appointments
And does not distinguish them — the source status column is not part of the exported column set. Every appointment not deleted outright is present, whether or not the patient was seen. Do not count rows in this file as visits; use patient_charts.csv. The appointment reason, booking source and scheduler comments are also outside the exported column set.
appointment_date and appointment_time are two columns
That is how the source table stores them. The date column carries no time of day and the time column carries no date. Concatenate them if a single timestamp is required.
patient_followup.csv is a plan, not a visit
It records what was asked for at an encounter — “come back in two weeks” — and says nothing about whether the patient was booked or ever seen. Do not count rows in this file as return visits. Use appointment.csv and patient_charts.csv for that.
Repeated blood pressure rows
chart_blood_pressure.csv holds one row per reading, and a single visit can record several. Join on chart_id.
Two nearly identical product files
wound_cellular_tissue_product_utilized.csv and wound_skin_substitute_product_utilized.csv are separate tables in the source system and differ in two columns each. They are not duplicates.
notes_text and notes_html side by side
In chart_progress_note.csv, the same note twice: once as plain text, once with its original formatting. They are not two different notes. The same pattern applies to content_text and content_html in chart_narrative_export.csv.
chart_familyhistory.csv repeats the relative, not the row
One row is one relative-and-condition pair, so a mother with three recorded conditions is three rows all reading relation = 'Mother'. icd_code and description can each be blank independently: a family history typed as free text has a description and no code.
ROS and Physical Exam share one file
chart_narrative_export.csv holds both, told apart by module_name: ros for the Review of Systems, physical_exam for the Physical Exam. One row is one module of one encounter, so an encounter recording both appears twice and one recording neither does not appear at all.
A missing row in chart_narrative_export.csv does not mean the exam was not done
Unlike every other file, its rows are rendered rather than read from a table. An encounter with no row either recorded nothing, or was one the rendering could not process. manifest.csv distinguishes the two: narrative_build_failed counts encounters that failed to render, and narrative_build_skipped_no_content counts those that genuinely held nothing.
signed and is_televisit are 0 or 1
In patient_charts.csv, signed = 1 means the encounter was signed off by a clinician. In appointment.csv, is_televisit = 1 means the appointment was booked as a video visit.
10. Requesting an export
| Export | Who may run it | How |
|---|---|---|
| Single patient (C-CDA) | Any user with access to the patient's chart | From the patient's chart within the Maximus EHR application, at any time, without developer assistance |
| Population (FHIR Bulk Data) | A registered client holding a system/ scope | Through the FHIR API — see https://documents.maximus.care/ |
| Full practice archive | Authorised administrative user | From the Maximus EHR administration area; the archive is produced and downloaded directly |
No fee is charged for any of these exports.
11. Standards referenced
| Standard | Version | Specification |
|---|---|---|
| HL7 FHIR | Release 4 (4.0.1) | https://hl7.org/fhir/R4/ |
| HL7 FHIR US Core Implementation Guide | 6.1.0 (STU 6.1) | https://hl7.org/fhir/us/core/STU6.1/ |
| United States Core Data for Interoperability (USCDI) | v3 | https://www.healthit.gov/isp/united-states-core-data-interoperability-uscdi |
| HL7 FHIR Bulk Data Access (Flat FHIR) | 2.0.0 (STU 2) | https://hl7.org/fhir/uv/bulkdata/STU2/ |
| HL7 CDA R2 IG: Consolidated CDA Templates for Clinical Notes | Release 2.1 (US Realm) | https://www.hl7.org/implement/standards/product_brief.cfm?product_id=492 |
| HL7 CDA R2 IG: C-CDA Templates for Clinical Notes STU Companion Guide | Release 4.1 (US Realm) | https://www.hl7.org/implement/standards/product_brief.cfm?product_id=447 |
Notes on individual standards:
- HL7 FHIR — Base standard for all FHIR resources.
- HL7 FHIR US Core Implementation Guide — Profiles applied to exported FHIR resources.
- United States Core Data for Interoperability (USCDI) — Data classes covered by the C-CDA and FHIR exports.
- HL7 FHIR Bulk Data Access (Flat FHIR) — Group-level asynchronous export. This is the version adopted at 45 CFR 170.215 and the version this module implements.
- HL7 CDA R2 IG: Consolidated CDA Templates for Clinical Notes — Document templates for the C-CDA export.
- HL7 CDA R2 IG: C-CDA Templates for Clinical Notes STU Companion Guide — Companion guidance applied to the C-CDA export.
12. Contact
Questions about this document, or about an export in progress, should be directed to MaxRemind Inc. through the contact route given on the Maximus EHR certification page.