PFT Data CSV API

The following page defines data and fields that may be imported into MIE systems (WebChart, Enterprise Health) for spirometry (pulmonary function tests) using the PFT Data CSV API.

Audience

The abstract that follows should be presented to decision-makers or stakeholders interested in a general explanation of the PFT Data CSV API. Technical details are provided in the remaining sections.

Abstract

PFT data is stored for individual employees, along with information on the employee’s height and weight to compare to predicted results. The PFT Data CSV API imports data related to spirometry.
CSV refers to the type of file and format of data needed to import information into an EH system. API refers to how the data interacts with the EH system. See the Import Overview  page for a more detailed explanation of terminology.

Workflow Considerations

One consideration for importing PFT data is predicted values used in testing.

How Are Predicted Values Added in EH?

When results come from a legacy interface and are imported using the CSV API, or from a pulmonary testing machine, predicted values need to be passed from the interface. Predicted values are not calculated within EH for these cases. EH relies on the demographics data that was entered on the machine or into the legacy database, and the predicted values calculated there are stored in EH as-is.
If PFT numbers are ever added directly into EH via the pulmonary layout, then predicted values are calculated using a few of the prediction methods via Javascript within the layout and stored on the PFT table within EH. Demographics information stored in EH charts are used to calculate the predicted values for manual entry.

Specifications

The following sections provide insight for technical personnel working with the provided import specifications. Although the specifications provided include details on each field utilized in the import, the sections below include further discussion on best practices for imported data to provide the best functionality in Enterprise Health.
The PFT Data CSV API specifications are available here: [1]

Column Definitions and Specific Coded Values

Definitions for the columns utilized in the specification, as well as commonly used specific coded values appear on the Data Import Standards  page.

Field Requirements

The following fields (indicated in the Data Name column) are noted as required (R) or are recommended as best practice (BP) in the Summary Documents CSV API specification. Additional details and considerations are provided here.

Required

The following fields are required:

• Chart ID (documents.pat_id) and Chart ID Type (documents.pat_id_type) are used to to correctly identify a chart.
• External ID (documents.ext_doc_id): Identifies a record in the original data source (i.e., this is often the primary or unique key on the table of the legacy database that is being migrated to the MIE system).
• Test Date/Time (pft.test_datetime):The date (datetime) the PFT was performed. Also sets documents.service_date.
• FVC (pft_maneuver.fvc): Records the forced vital capacity (FVC - total volume expelled from lungs). Enter volume in milliliters (mL).

Optional Fields

The following optional fields are needed to link the document to a patient encounter:

• Encounter External Identifier (encounters.ext_id)
• Encounter Interface (encounters.interface) Including the field encounter order_id will also create an encounter order of the identified in the field.

EER Diagram

Source

Examples

The following examples are available:

• Google sheet
• Downloadable CSV

Related Pages

• Data Import Master List