Injections CSV API

The following page defines data and fields that may be imported into MIE systems (WebChart, Enterprise Health) for injections using the Injections CSV API.

Audience

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

Abstract

Enterprise Health stores discrete data for injections/immunizations, which can be displayed in multiple ways.

It is valuable to recognize the following terminology as it pertains to MIE systems:

  • chart is an employee’s (patient’s) electronic medical information organized in tabular form. A chart is simply a way to collect different information on one topic, just like a physical patient chart would contain a variety of information on an individual. Audio tests are linked to a chart through a document.
  • document in EH is a way of storing non-discrete information in patient charts. This includes patient photographs, insurance cards, physician or nurse notes, imaging studies, past medical histories, CCDs and CDAs, email correspondence about a patient, injections, and many other forms of data.
  • An encounter documents a visit with a employee, and is also known as a patient visit. An encounter is a template of specific items to be addressed, in part or completely, during an appointment including the subjective, objective, assessment and plan. This is a tool used for recording information collected during an appointment and, in turn, the data collected will be stored and also incorporated in the final desired outcome: the visit report/note, which is a document stored in EH.

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.

Screenshots

Injections data is stored as a document, and will display within the appropriate tab of a chart.

In addition, injections display within the Injections flowsheet chart tab as discrete data.

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.

Specifications for the Injections CSV API are available here.

Tip

The specification may be downloaded as Excel, CSV, or duplicated as an online spreadsheet under the File menu.

Additionally, user instructions are available for importing data in EH.

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.

CDC Injection Codes

The CDC Immunization Information Systems CVX Codes are available here: http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx

Injections Site Codes

Enterprise Health Site Codes Enterprise Health Site Descriptions
AB Abdomin
RG Right Glute
LG Left Glute
LD Left Deltoid
RD Right Deltoid
LAF Left Arm Forearm
RAF Right Arm Forearm
LT Left Thigh
RT Right Thigh
RA Right Arm
RAL Right Arm Lower Site
RAU Right Arm Upper Site
RD Right Deltoid
RT Right Thigh
RG Right Gluteus
RVL Right Vastus Lateralis
LA Left Arm
LAL Left Arm Lower Site
LAU Left Arm Upper Site
LD Left Deltoid
LT Left Thigh
LG Left Gluteus
LVL Left Vastus Lateralis
AB Abdomen
O Oral
BN Both Nares
OTHER Other

Injections Route Codes

Enterprise Health Route Codes Enterprise Health Route Descriptions
ID Intradermal
IM Intramuscular
IV Intravenous
PO Oral
SC Subcutaneous
OTH Other
IN Intranasal
IA Intraarticular
TD Transdermal

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 Injections 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 (documents.service_date) is used to indicate when the test was conducted, and must be in SQL format. YYYY-MM-DD HH:MM:SS (2015-09-28 15:42:24).
  • Injection Description (injections.description) is the text description of the injection given.
Best Practice

The following fields are optional, but provide useful details for record keeping purposes:

  • CDC Injection Code (injections.inject_code) documents the CDC Immunization Information Systems CVX Codes. See CDC Injection Codes.
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.

Examples

Examples using sample data are provided on

Validation

Unless otherwise specified, validation between the previous system and the new EH system requires the client to provide a number of test patients. This data can be compared in the previous system and EH using the validation test script.

WebChart Documentation
Last Build: Wed, 08 Sep 2021 00:25:59 EDT Legacy Documentation